API Gateway から HTTP API をエクスポートする

HTTP API を作成したら、API Gateway から API の OpenAPI 3.0 定義をエクスポートできます。エクスポートするステージを選択するか、API の最新の設定をエクスポートできます。エクスポートした API 定義を API Gateway にインポートして、同一の API をもう 1 つ作成することもできます。API 定義のインポートの詳細については、「HTTP API のインポート」を参照してください。

AWS CLI を使用してステージの OpenAPI 3.0 定義をエクスポートする

次の export-api コマンドは、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

AWS CLI を使用して API の最新変更の OpenAPI 3.0 定義をエクスポートする

次の export-api コマンドは、HTTP API の OpenAPI 定義を latest-api-definition.json という名前の JSON ファイルにエクスポートします。このコマンドはステージを指定しないため、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 定義をエクスポートする方法を示しています。