Exportieren Sie HTTP-APIs aus dem API Gateway - APIAmazon-Gateway
Exportieren Sie eine OpenAPI 3.0-Definition einer Phase mithilfe der CLI AWSExportieren Sie eine OpenAPI 3.0-Definition der neuesten Änderungen Ihrer API mithilfe der CLI AWSExportieren einer OpenAPI 3.0-Definition mithilfe der API-Gateway-Konsole

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.

Exportieren Sie HTTP-APIs aus dem API Gateway

Nachdem Sie ein HTTP-API erstellt haben, können Sie eine OpenAPI 3.0-Definition Ihrer API aus API Gateway exportieren. Sie können entweder eine Stufe auswählen, die exportiert werden soll, oder die neueste Konfiguration Ihrer API exportieren. Sie können auch eine exportierte API-Definition nach API Gateway importieren, um eine weitere, identische API zu erstellen. Weitere Informationen zum Importieren von API-Definitionen finden Sie unter Importieren einer HTTP-API.

Exportieren Sie eine OpenAPI 3.0-Definition einer Phase mithilfe der CLI AWS

Der folgende Befehl exportiert eine OpenAPI-Definition einer API-Stufe namens prod in eine YAML-Datei namens stage-definition.yaml. Die exportierte Definitionsdatei enthält standardmäßig API Gateway-Erweiterungen.

aws apigatewayv2 export-api \
    --api-id api-id  \
    --output-type YAML  \
    --specification OAS30 \
    --stage-name prod \
    stage-definition.yaml

Exportieren Sie eine OpenAPI 3.0-Definition der neuesten Änderungen Ihrer API mithilfe der CLI AWS

Der folgende Befehl exportiert eine OpenAPI-Definition einer HTTP-API in eine JSON-Datei namens latest-api-definition.json. Da der Befehl keine Stufe angibt, exportiert API Gateway die neueste Konfiguration Ihrer API, unabhängig davon, ob sie auf einer Stufe bereitgestellt wurde oder nicht. Die exportierte Definitionsdatei enthält keine API Gateway-Erweiterungen.

aws apigatewayv2 export-api \
    --api-id api-id  \
    --output-type JSON  \
    --specification OAS30 \
    --no-include-extensions \
    latest-api-definition.json

Weitere Informationen finden Sie unter ExportAPI in der API-Referenz für Amazon API Gateway Version 2.

Exportieren einer OpenAPI 3.0-Definition mithilfe der API-Gateway-Konsole

Das folgende Verfahren zeigt, wie Sie eine OpenAPI-Definition einer HTTP-API exportieren.

Exportieren einer OpenAPI 3.0-Definition mithilfe der API-Gateway-Konsole

  1. Melden Sie sich bei der API-Gateway-Konsole unter https://console.aws.amazon.com/apigateway an.

  2. Wählen Sie eine HTTP-API.

  3. Wählen Sie im Hauptnavigationsbereich unter Entwickeln die Option Exportieren aus.

  4. Wählen Sie aus den folgenden Optionen, um Ihre API zu exportieren:

    Exportoptionen für HTTP-APIs.

    1. Wählen Sie unter Quelle eine Quelle für die OpenAPI 3.0-Definition aus. Sie können entweder eine Stufe auswählen, die exportiert werden soll, oder die neueste Konfiguration Ihrer API exportieren.

    2. Aktivieren Sie API Gateway-Erweiterungen einschließen, um API-Gateway-Erweiterungen einzubeziehen.

    3. Wählen Sie unter Ausgabeformat ein Ausgabeformat aus.

  5. Wählen Sie Herunterladen aus.