Dokumentieren von REST-APIs - Amazon API Gateway

Dokumentieren von REST-APIs

Um Kunden dabei zu helfen, Ihre API zu verstehen und zu verwenden, sollten Sie die API dokumentieren. Dazu können Sie mithilfe von API Gateway Hilfeinhalte für einzelne API-Entitäten als festen Bestandteil Ihres API-Entwicklungsprozesses hinzufügen und aktualisieren. API Gateway speichert die Quellinhalte und ermöglicht es Ihnen, verschiedene Versionen der Dokumentation zu archivieren. Sie können eine Dokumentationsversion mit einer API-Phase verknüpfen, einen Dokumentations-Snapshot zu einer bestimmten Phase in eine externe OpenAPI-Datei exportieren und die Datei zur Veröffentlichung der Dokumentation verteilen.

Um Ihre API zu dokumentieren, können Sie die API-Gateway-REST-API aufrufen, eines der AWS-SDKs oder AWS CLIs für API Gateway verwenden oder die API-Gateway-Konsole verwenden. Sie haben auch die Möglichkeit, die in einer externen OpenAPI-Datei definierten Dokumentationsbausteine zu importieren oder zu exportieren.

Wenn Sie API-Dokumentation mit Entwicklern teilen möchten, können Sie ein Entwicklerportal verwenden. Ein Beispiel finden Sie unter Integrieren einer ReadMe-Datei in API Gateway, um Ihren Developer Hub auf dem neuesten Stand zu halten im Blog vom AWS-Partnernetzwerk (APN).

Themen