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.
RESTAPIAus API Gateway exportieren
Sobald Sie ein REST API API Gateway mit der API Gateway-Konsole oder auf andere Weise erstellt und konfiguriert haben, können Sie es mit dem API Gateway-ExportAPI, der Teil des Amazon API Gateway Control Service ist, in eine offene API Datei exportieren. Um den API Gateway-Export verwenden zu könnenAPI, müssen Sie Ihre API Anfragen signieren. Weitere Informationen zum Signieren von Anfragen finden Sie unter Signieren von AWS API Anfragen im IAMBenutzerhandbuch. Sie haben die Möglichkeit, die API Gateway-Integrationserweiterungen sowie die Postman-Erweiterungen
Anmerkung
Achten Sie beim Exportieren API von darauf AWS CLI, dass Sie den Erweiterungsparameter angeben, wie im folgenden Beispiel gezeigt, um sicherzustellen, dass die x-amazon-apigateway-request-validator Erweiterung enthalten ist:
aws apigateway get-export --parameters extensions='apigateway' --rest-api-id abcdefg123 --stage-name dev --export-type swagger latestswagger2.json
Sie können eine nicht exportierenAPI, wenn ihre Payloads nicht von diesem application/json Typ sind. Wenn Sie es versuchen, erhalten Sie eine Fehlermeldung, die besagt, dass keine JSON Körpermodelle gefunden wurden.
Anfrage zum Export eines REST API
Mit dem Export exportieren Sie ein vorhandenes ObjektAPI, REST API indem Sie eine GET Anfrage einreichen und das to-be-exported API als Teil von URL Pfaden angeben. Die Anfrage hat URL das folgende Format:
Sie können die extensions Abfragezeichenfolge anhängen, um anzugeben, ob API Gateway-Erweiterungen (mit dem integration Wert) oder Postman-Erweiterungen (mit dem postman Wert) eingeschlossen werden sollen.
Darüber hinaus können Sie den Accept Header so einstellen, dass application/json er die API Definitionsausgabe im jeweiligen YAML Format JSON oder als Ausgabeformat erhält. application/yaml
Weitere Informationen zum Einreichen von GET Anfragen mithilfe des API Gateway-Exports API finden Sie unter GetExport.
Anmerkung
Wenn Sie Modelle in Ihrem definierenAPI, müssen diese für den Inhaltstyp „application/json“ sein, damit API Gateway das Modell exportieren kann. Andernfalls löst API Gateway eine Ausnahme mit der Fehlermeldung „Nur gefundene JSON Nicht-Body-Modelle für...“ aus.
Modelle müssen Eigenschaften enthalten oder als bestimmter JSONSchema Typ definiert sein.
Download API Definition REST API öffnen in JSON
Um API Definitionen REST API im JSON Format Open zu exportieren und herunterzuladen:
Hier kann <region>us-east-1 sein. Informationen zu allen Regionen, in denen API Gateway verfügbar ist, finden Sie unter Regionen und Endpunkte.
Laden Sie REST API die API Definition herunter in YAML
Um API Definitionen REST API im YAML Format Open zu exportieren und herunterzuladen:
Laden Sie REST API Open API Definition mit Postman-Erweiterungen herunter in JSON
So exportieren und laden Sie eine API Definition REST API im JSON Format „PostmanIn Open“ herunter:
Laden Sie REST API die API Open-Definition mit API Gateway-Integration herunter in YAML
Um eine REST API API Open-Definition mit API Gateway-Integration im YAML Format zu exportieren und herunterzuladen:
Exportieren REST API Sie mit der API Gateway-Konsole
Nach der Bereitstellung REST API auf einer Stage können Sie mit dem Exportieren der API In-the-Phase mithilfe der API Gateway-Konsole in eine API Open-Datei fortfahren.
Wählen Sie in der API Gateway-Konsole im Bereich Stages die Optionen Stage-Aktionen und Export aus.
Geben Sie einen APISpezifikationstyp, ein Format und Erweiterungen an, um Ihre API API Open-Definition herunterzuladen.
