APIDokumentation importieren - APIAmazon-Gateway

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.

APIDokumentation importieren

Wie beim Import von API Entitätsdefinitionen können Sie Dokumentationsteile aus einer externen API Open-Datei API in eine API In-Gateway-Datei importieren. Sie geben die to-be-imported Dokumentationsteile innerhalb der x-amazon-apigateway-documentation Objekt Erweiterung in einer gültigen API Open-Definitionsdatei an. Durch das Importieren der Dokumentation werden die vorhandenen API Entitätsdefinitionen nicht geändert.

Sie haben die Möglichkeit, die neu angegebenen Dokumentationsteile mit vorhandenen Dokumentationsteilen in API Gateway zusammenzuführen oder die vorhandenen Dokumentationsteile zu überschreiben. In diesem MERGE Modus wird ein neuer Dokumentationsteil, der in der API Datei Öffnen definiert ist, der DocumentationParts Sammlung von hinzugefügt. API Wenn bereits ein importierter DocumentationPart vorhanden ist, ersetzt ein importiertes Attribut jeweils einen vorhandenen Baustein, sofern einer der beiden unterschiedlich ist. Andere vorhandene Dokumentationsattribute bleiben davon unberührt. In diesem OVERWRITE Modus wird die gesamte DocumentationParts Sammlung entsprechend der importierten API Open-Definitionsdatei ersetzt.

Teile der Dokumentation mithilfe des API Gateways importieren REST API

Um API Dokumentation mit dem API Gateway zu importieren RESTAPI, rufen Sie den Vorgang documentationpart:import auf. Das folgende Beispiel zeigt, wie vorhandene Dokumentationsteile von an API mit einer einzigen GET / Methode überschrieben werden und bei Erfolg eine Antwort zurückgegeben wird. 200 OK

OpenAPI 3.0
PUT /restapis/<restapi_id>/documentation/parts&mode=overwrite&failonwarnings=true Host: apigateway.region.amazonaws.com Content-Type: application/json X-Amz-Date: YYYYMMDDTttttttZ Authorization: AWS4-HMAC-SHA256 Credential=access_key_id/YYYYMMDD/region/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature=sigv4_secret { "openapi": "3.0.0", "info": { "description": "description", "version": "1", "title": "doc" }, "paths": { "/": { "get": { "description": "Method description.", "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } } } } } } }, "x-amazon-apigateway-documentation": { "version": "1.0.3", "documentationParts": [ { "location": { "type": "API" }, "properties": { "description": "API description", "info": { "description": "API info description 4", "version": "API info version 3" } } }, { "location": { "type": "METHOD", "method": "GET" }, "properties": { "description": "Method description." } }, { "location": { "type": "MODEL", "name": "Empty" }, "properties": { "title": "Empty Schema" } }, { "location": { "type": "RESPONSE", "method": "GET", "statusCode": "200" }, "properties": { "description": "200 response" } } ] }, "servers": [ { "url": "/" } ], "components": { "schemas": { "Empty": { "type": "object", "title": "Empty Schema" } } } }
OpenAPI 2.0
PUT /restapis/<restapi_id>/documentation/parts&mode=overwrite&failonwarnings=true Host: apigateway.region.amazonaws.com Content-Type: application/json X-Amz-Date: YYYYMMDDTttttttZ Authorization: AWS4-HMAC-SHA256 Credential=access_key_id/YYYYMMDD/region/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature=sigv4_secret { "swagger": "2.0", "info": { "description": "description", "version": "1", "title": "doc" }, "host": "", "basePath": "/", "schemes": [ "https" ], "paths": { "/": { "get": { "description": "Method description.", "produces": [ "application/json" ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/Empty" } } } } } }, "definitions": { "Empty": { "type": "object", "title": "Empty Schema" } }, "x-amazon-apigateway-documentation": { "version": "1.0.3", "documentationParts": [ { "location": { "type": "API" }, "properties": { "description": "API description", "info": { "description": "API info description 4", "version": "API info version 3" } } }, { "location": { "type": "METHOD", "method": "GET" }, "properties": { "description": "Method description." } }, { "location": { "type": "MODEL", "name": "Empty" }, "properties": { "title": "Empty Schema" } }, { "location": { "type": "RESPONSE", "method": "GET", "statusCode": "200" }, "properties": { "description": "200 response" } } ] } }

Bei Erfolg gibt diese Anforderung eine "200 OK"-Antwort zurück, die die importierte DocumentationPartId in der Nutzlast enthält.

{ "ids": [ "kg3mth", "796rtf", "zhek4p", "5ukm9s" ] }

Darüber hinaus können Sie auch restapi:import oder restapi:put aufrufen und dabei die Dokumentationsteile im x-amazon-apigateway-documentation Objekt als Teil der Open-Eingabedatei der Definition angeben. API API Um die Dokumentationsteile vom API Import auszuschließen, geben Sie die Abfrageparameter der Anfrage einignore=documentation.

Teile der Dokumentation mithilfe der API Gateway-Konsole importieren

In den folgenden Anweisungen wird beschrieben, wie Sie Dokumentationsbausteine importieren.

Um die Konsole zum Importieren von Dokumentationsteilen API aus einer externen Datei zu verwenden
  1. Klicken Sie im Hauptnavigationsbereich auf Documentation (Dokumentation).

  2. Wählen Sie Importieren aus.

  3. Wenn Sie bereits über eine Dokumentation verfügen, wählen Sie Overwrite (Überschreiben) oder Merge (Zusammenführen) aus, um Ihre neue Dokumentation entweder zu überschreiben oder zusammenzuführen.

  4. Wählen Sie Choose file (Datei auswählen) aus, um eine Datei von einem Laufwerk zu laden, oder geben Sie die Inhalte einer Datei in die Dateiansicht ein. Ein Beispiel finden Sie in der Nutzlast der Beispielanforderung unter Teile der Dokumentation mithilfe des API Gateways importieren REST API.

  5. Wählen Sie aus, wie mit Warnungen beim Import umgegangen werden soll. Wählen Sie entweder Fail on warnings (Bei Warnungen fehlschlagen) oder Ignore warnings (Warnungen ignorieren). Weitere Informationen finden Sie unter Fehler und Warnungen beim Import Ihres API in API Gateway.

  6. Wählen Sie Importieren aus.