メニュー
Amazon API Gateway
開発者ガイド

Swagger 定義をインポートして API を作成する

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

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

Copy
{ "swagger": "2.0", "info": { "title": "Simple PetStore (Swagger)" }, "schemes": [ "https" ], "paths": { "/": { "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" } } } } }

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

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

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

  2. [Create API] を選択します。

  3. [Import from Swagger] を選択します。

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

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

API Gateway REST API を使用して Swagger 定義をインポートするには、restapi:import アクションを呼び出し、前述の Swagger 定義をペイロードとして渡します。詳細については、restapi:import トピックの「解説」セクションの例を参照してください。

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

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