Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
Dokumentation für REST-APIs in API Gateway
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.
Sie können optional die API-Gateway-REST-API aufrufen, eines der AWS-SDKs
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
Themen
