Amazon API Gateway
開発者ガイド

OpenAPI 定義をインポートしてエッジ最適化 API をセットアップする

適切な API Gateway API エンティティの OpenAPI 定義を指定し、その OpenAPI 定義を API Gateway 内にインポートすることにより、API Gateway で API をセットアップできます。

次の OpenAPI 定義で記述するシンプルな API では、バックエンドで PetStore ウェブサイトの HTTP エンドポイントと統合された GET / メソッドのみを公開し、200 OK レスポンスを返します。

OpenAPI 2.0
OpenAPI 2.0
{ "swagger": "2.0", "info": { "title": "Simple PetStore (OpenAPI)" }, "schemes": [ "https" ], "paths": { "/pets": { "get": { "responses": { "200": { "description": "200 response" } }, "x-amazon-apigateway-integration": { "responses": { "default": { "statusCode": "200" } }, "uri": "http://petstore-demo-endpoint.execute-api.com/petstore/pets", "passthroughBehavior": "when_no_match", "httpMethod": "GET", "type": "http" } } }, "/pets/{petId}": { "get": { "parameters": [ { "name": "petId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "200 response" } }, "x-amazon-apigateway-integration": { "responses": { "default": { "statusCode": "200" } }, "requestParameters": { "integration.request.path.id": "method.request.path.petId" }, "uri": "http://petstore-demo-endpoint.execute-api.com/petstore/pets/{id}", "passthroughBehavior": "when_no_match", "httpMethod": "GET", "type": "http" } } } } }

次の手順では、API Gateway コンソールを使用して、これらの OpenAPI 定義を API Gateway 内にインポートする方法について説明します。

API Gateway コンソールを使用してシンプルな OpenAPI 定義をインポートするには

  1. API Gateway コンソールにサインインします。

  2. [Create API (API の作成)] を選択します。

  3. [Import from OpenAPI (OpenAPI からインポート)] を選択します。

  4. 前述の OpenAPI 定義をファイルに保存している場合は、[Select OpenAPI File (OpenAPI ファイルの選択)] を選択します。OpenAPI 定義をコピーしてインポートテキストエディタ内に貼り付けることもできます。

  5. [インポート] を選択して OpenAPI 定義のインポートを完了します。

AWS CLI を使用して OpenAPI 定義をインポートするには、OpenAPI 定義をファイルに保存し、以下のコマンドを実行します。この例では、us-west-2 リージョンと、OpenAPI ファイルの絶対パスとして file:///path/to/API_OpenAPI_template.json を使用しています。

aws apigateway import-rest-api --body 'file:///path/to/API_OpenAPI_template.json' --region us-west-2