チュートリアル: HTTP 非プロキシ統合を使用して REST API を作成する

API を作成するには

1. https://console.aws.amazon.com/apigateway で API Gateway コンソールにサインインします。

2. API Gateway を初めて使用する場合は、サービスの特徴を紹介するページが表示されます。[REST API] で、[構築] を選択します。[Create Example API (サンプル API の作成)] がポップアップ表示されたら、[OK] を選択します。

   API Gateway を使用するのが初めてではない場合、[Create API] (API を作成)を選択します。[REST API] で、[構築] を選択します。

3. [API 名] に「HTTPNonProxyAPI」と入力します。

4. (オプション) [説明] に説明を入力します。

5. [API エンドポイントタイプ] を [リージョン別] に設定したままにします。

6. API の作成 を選択します。

/pets リソースを作成するには

1. [リソースの作成] を選択します。

2. [プロキシのリソース] はオフのままにします。

3. [リソースパス] は / のままにします。

4. [リソース名] に「pets」と入力します。

5. [CORS (Cross Origin Resource Sharing)] はオフのままにします。

6. [リソースの作成] を選択します。

/pets リソースで GET メソッドを作成するには

1. /pets リソースを選択します。

2. [メソッドの作成] を選択します。

3. [メソッドタイプ] には、GET を選択します。

4. [統合タイプ] で、[HTTP 統合] を選択します。

5. [HTTP プロキシ統合] はオフのままにします。

6. [HTTP メソッド] で、[GET] を選択します。

7. [エンドポイント URL] に「http://petstore-demo-endpoint.execute-api.com/petstore/pets」と入力します。

   PetStore ウェブサイトでは、特定のページでペットの種類 (「Dog」や「Cat」など) ごとに、Pet 項目のリストを取得できます。

8. [コンテンツの処理] で、[パススルー] を選択します。

9. [URL クエリ文字列パラメータ] を選択します。

   PetStore ウェブサイトでは、type および page クエリ文字列パラメータを使用して入力を受け取ります。メソッドリクエストにクエリ文字列パラメータを追加して、統合リクエストの対応するクエリ文字列パラメータにマッピングします。

10. クエリ文字列パラメータを追加するには、次の操作を行います。

    1. [クエリ文字列の追加] を選択します。

    2. [名前] に「type」と入力します。

    3. [必須] と [キャッシュ] はオフのままにしておきます。

    前の手順を繰り返し、page という名前で追加のクエリ文字列を作成します。

11. [メソッドの作成] を選択します。

入力パラメータを統合リクエストにマッピングするには

1. [統合リクエスト] タブの [統合リクエストの設定] で、[編集] を選択します。

2. [URL クエリ文字列パラメータ] を選択し、次の操作を行います。

   1. [クエリ文字列パラメータを追加] を選択します。

   2. [名前] に type と入力します。

   3. [マッピング元] として「method.request.querystring.type」と入力します。

   4. [キャッシュ] はオフのままにします。

   5. [クエリ文字列パラメータを追加] を選択します。

   6. [名前] に page と入力します。

   7. [マッピング元] として「method.request.querystring.page」と入力します。

   8. [キャッシュ] はオフのままにします。

3. [Save] を選択します。

API をテストするには

1. [テスト] タブを選択します。タブを表示するには、右矢印ボタンを選択する必要がある場合があります。

2. [クエリ文字列] に「type=Dog&page=2」と入力します

3. [テスト] を選択します。

   結果は次の例のようになります。

   

   これでテストが成功したので、API をデプロイし、公開することができます。

4. [API のデプロイ] を選択します。

5. [ステージ] で [新規ステージ] を選択します。

6. [Stage name (ステージ名)] に Prod と入力します。

7. (オプション) [説明] に説明を入力します。

8. [デプロイ] を選択します。

9. (オプション) [ステージの詳細] の [呼び出し URL] で、コピーアイコンを選択して API の呼び出し URL をコピーします。Postman や cURL のようなツールでこれを使用して API をテストできます。

{petId} リソースを作成するには

1. /pets リソースを選択し、[リソースを作成] を選択します。

2. [プロキシのリソース] はオフのままにします。

3. [リソースパス] として、[/pets/]を選択します。

4. [リソース名] に「{petId}」と入力します。

   petId の周りに波括弧 ({ }) を使用し、/pets/{petId} と表示されるようにします。

5. [CORS (Cross Origin Resource Sharing)] はオフのままにします。

6. [リソースの作成] を選択します。

GET メソッドをセットアップするには

1. /{petId} リソースを選択し、[メソッドを作成] を選択します。

2. [メソッドタイプ] には、GET を選択します。

3. [統合タイプ] で、[HTTP 統合] を選択します。

4. [HTTP プロキシ統合] はオフのままにします。

5. [HTTP メソッド] で、[GET] を選択します。

6. [エンドポイント URL] に「http://petstore-demo-endpoint.execute-api.com/petstore/pets/{id}」と入力します。

7. [コンテンツの処理] で、[パススルー] を選択します。

8. [デフォルトタイムアウト] はオンのままにします。

9. [メソッドの作成] を選択します。

{petId} パスパラメータをマッピングするには

1. [統合リクエスト] タブの [統合リクエストの設定] で、[編集] を選択します。

2. [URL パスパラメータ] を選択します。

3. API Gateway は petId という名前の統合リクエストのパスパラメータを作成しますが、このパスパラメータはバックエンド統合として設定した HTTP エンドポイント URL には無効です。HTTP エンドポイントはパスパラメータとして {id} を使用します。[名前] で、petId を削除し、id を入力します。

   これは petId のメソッドリクエストのパスパラメータを、id の統合リクエストのパスパラメータにマッピングします。

4. [Save] を選択します。

メソッドをテストするには

1. [テスト] タブを選択します。タブを表示するには、右矢印ボタンを選択する必要がある場合があります。

2. petId の [パス] に、「4」と入力します。

3. [Test (テスト)] を選択します。

   成功すると、[レスポンス本文] に次の内容が表示されます。

   {
     "id": 4,
     "type": "bird",
     "price": 999.99
   }

API をデプロイする

1. [API のデプロイ] を選択します。

2. [ステージ] で [実稼働] を選択します。

3. (オプション) [説明] に説明を入力します。

4. [デプロイ] を選択します。

1. メインナビゲーションペインで、[ステージ] を選択します。

2. [ステージの詳細] で、コピーアイコンを選択して API の呼び出し URL をコピーします。

   次のように表示されます。

   https://my-api-id.execute-api.region-id.amazonaws.com/prod

3. リクエストを送信する前に、この URL をブラウザの新しいタブのアドレスボックスに入力し、/pets/4 を URL に付加します。

4. ブラウザは以下を返します。

   {
     "id": 4,
     "type": "bird",
     "price": 999.99
   }