Amazon API Gateway
開発者ガイド

例から API Gateway API を構築する

API Gateway API を構築してテストするための基本的なワークフローを開始するには、Amazon API Gateway コンソールを使用して PetStore ウェブサイトの HTTP 統合で簡単な API を作成してテストします。API 定義は OpenAPI 2.0 ファイルとして事前設定されています。API 定義を API Gateway にロードしたあと、API Gateway コンソールを使用して API の基本構造を確認するか、単純に API をデプロイしてテストすることができます。

サンプル API は、クライアントがhttp://petstore-demo-endpoint.execute-api.com/petstore/petsの HTTP バックエンドウェブサイトをアクセスするための以下の方法をサポートします。

  • GET /: どのバックエンドエンドポイントとも統合されていない API のルートリソースへの読み取りアクセス。API Gateway は PetStore ウェブサイトの概要で応答します。これは MOCK 統合タイプの例です。

  • GET /pets: 同様の名前のバックエンド /pets リソースと統合されている API の /pets リソースへの読み取りアクセス。バックエンドは PetStore で利用可能なペットのページを返します。これは HTTP 統合タイプの例です。統合エンドポイントの URL はhttp://petstore-demo-endpoint.execute-api.com/petstore/pets です。

  • POST /pets: バックエンド /pets リソースと統合されている API の /petstore/pets リソースへの書き込みアクセス。正しいリクエストを受信すると、バックエンドは指定されたペットを PetStore に追加し、結果を呼び出し元に返します。統合は HTTP でもあります。

  • GET /pets/{petId}: 受信リクエスト URL のパス変数として指定される petId 値によって識別されるペットへの読み取りアクセス。このメソッドには HTTP 統合タイプもあります。バックエンドは PetStore で見つかった指定されたペットを返します。バックエンド HTTP エンドポイントの URL は http://petstore-demo-endpoint.execute-api.com/petstore/pets/n で、n は照会されたペットの識別子としての整数です。

API は MOCK 統合タイプの OPTIONS メソッドを通じて CORS アクセスをサポートします。API Gateway は、CORS アクセスをサポートする必須のヘッダーを返します。

以下の資料も参照してください。

API Gateway Lambda オーソライザーの使用Amazon API Gateway での REST API のデプロイ