Dokumentation für REST APIs in API Gateway

Um Kunden zu helfenAPI, Ihre zu verstehen und zu verwenden, sollten Sie die dokumentierenAPI. Um Ihnen bei der Dokumentation zu helfenAPI, können Sie mit API Gateway den Hilfeinhalt für einzelne API Entitäten als integralen Bestandteil Ihres API Entwicklungsprozesses hinzufügen und aktualisieren. APIGateway speichert den Quellinhalt und ermöglicht es Ihnen, verschiedene Versionen der Dokumentation zu archivieren. Sie können einer API Phase eine Dokumentationsversion zuordnen, einen phasenspezifischen Dokumentationssnapshot in eine externe API Open-Datei exportieren und die Datei als Publikation der Dokumentation verteilen.

Um dies zu dokumentierenAPI, können Sie das APIGateway aufrufen RESTAPI, eines von verwenden AWS SDKs, das AWS CLIfür API Gateway verwenden oder die Gateway-Konsole verwenden. API Darüber hinaus können Sie die Dokumentationsteile importieren oder exportieren, die in einer externen API Open-Datei definiert sind.

Um die API Dokumentation mit Entwicklern zu teilen, können Sie ein Entwicklerportal verwenden. Ein Beispiel finden Sie im Blog Integration ReadMe mit API Gateway, um Ihren Entwickler-Hub auf dem neuesten Stand zu halten, oder Im Blog So optimieren Sie die API Entwicklung SwaggerHub auf Amazon API Gateway mithilfe SmartBear des AWS Partnernetzwerks (APN).

Themen

• Darstellung der API Dokumentation in Gateway API
• Dokumentieren API Sie und verwenden Sie die API Gateway-Konsole
• Veröffentlichen Sie die API Dokumentation mithilfe der API Gateway-Konsole
• Dokument und API Verwendung des API Gateways REST API
• Veröffentlichen Sie die API Dokumentation mithilfe des API Gateways REST API
• APIDokumentation importieren
• Steuern Sie den Zugriff auf die API Dokumentation in API Gateway