從 API Gateway 匯出 HTTP API - Amazon API Gateway

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

從 API Gateway 匯出 HTTP API

建立 HTTP API 之後,您可以從 API Gateway 匯出您的 API 的 OpenAPI 3.0 定義。您可以選擇要匯出的階段,也可以匯出 API 的最新組態。您也可以將匯出的 API 定義匯入到 API Gateway,以建立另一個相同的 API。若要進一步了解如何匯入 API 定義,請參閱匯入 HTTP API

使用 CLI 匯出階段的 OpenAPI 3.0 定義 AWS

下列命令會將名為 prod 的 API 階段的 OpenAPI 定義匯出至名為 stage-definition.yaml 的 YAML 檔案。匯出的定義檔案預設會包含 API Gateway 延伸

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

使用 CLI 令列 AWS 匯出 API 最新變更的 OpenAPI 3.0 定義

下列命令會將 HTTP API 的 OpenAPI 定義匯出至名為 latest-api-definition.json 的 JSON 檔案。由於命令未指定階段,因此無論 API 是否已部署至階段,API Gateway 都會匯出 API 的最新組態。匯出的定義檔案不會包含 API Gateway 延伸

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

如需詳細資訊,請參閱《Amazon API Gateway 第 2 版 API 參考》中的 ExportAPI

使用 API Gateway 主控台匯出 OpenAPI 3.0 定義

下列程序說明如何匯出 HTTP API 的 OpenAPI 定義。

若要使用 API Gateway 主控台匯出 OpenAPI 3.0 定義
  1. 在以下網址登入 API Gateway 主控台:https://console.aws.amazon.com/apigateway

  2. 選擇一個 HTTP API。

  3. 在主導覽窗格的開發底下,選擇匯出

  4. 從下方選取匯出 API 的選項:

    適用於 HTTP API 的匯出選項。
    1. 針對來源,選取 OpenAPI 3.0 定義的來源。您可以選擇要匯出的階段,也可以匯出 API 的最新組態。

    2. 開啟包含 API Gateway 延伸模組以包含 API Gateway 延伸模組

    3. 針對輸出格式,選取輸出格式。

  5. 選擇 Download (下載)。