Veröffentlicht am: Dec 1, 2016
Für die Methoden und Ressourcen von API, die mit Hilfe von Amazon API Gateway entwickelt wurden, können Sie jetzt Dokumentationsunterlagen erstellen. So können Ihre API-Nutzer leichter nachvollziehen, wie die Programmierschnittstelle funktioniert. Sie können die Dokumentation für Ihre API direkt über die API-Gateway-Konsole, die CLI und das SDK hinzufügen oder sie einfach mithilfe von Dokumentations-Tags in der Swagger-Definition für die API angeben. Sie können die Dokumentation auch für allgemeine Aspekte Ihrer API wiederverwenden. Beispielsweise können Sie eine Standardfehlerdokumentation nur einmal verfassen und in mehreren API-Antworten verwenden, ohne den eigentlichen Inhalt zu duplizieren. Auf diese Weise können Sie Ihre APIs schneller dokumentieren und Fehler beim Kopieren und Einfügen beseitigen, die bei doppelten Zeichenfolgen auftreten können. Sobald Ihre Dokumentation als Teil einer API-Phase veröffentlicht wurde, können Sie mithilfe der Swagger-Exportfunktion exportieren und in Ihrem Entwicklerportal verfügbar machen.
API Gateway bietet Ihnen unabhängige Workflows für die API-Definition und API-Dokumentation. Auf diese Weise können API-Entwickler und technische Redakteure parallel arbeiten und ihren Swagger mithilfe von Konsole, CLI und SDK separat importieren.
Weitere Informationen finden Sie unter Dokumentieren einer API-Gateway-API.