Amazon API Gateway
開発者ガイド

エッジ最適化 API を API Gateway にインポートする

API OpenAPI 定義ファイルをインポートして、新しいエッジ最適化 API を作成できます。そのためには、OpenAPI ファイルに加えて EDGE エンドポイントタイプをインポートオペレーションへの入力として指定します。この操作には、API Gateway コンソール、AWS CLI、AWS SDK、または API Gateway REST API を使用できます。

API Gateway コンソールを使用してエッジ最適化 API をインポートする

API Gateway コンソールを使用してエッジ最適化 API エンドポイントタイプの API をインポートするには、以下の手順を実行します。

  1. API Gateway コンソールにサインインし、[+ API の作成] を選択します。

  2. [新しい API の作成] で、[Import from OpenAPI (OpenAPI からインポート)] オプションを選択します。

  3. API OpenAPI 定義をコピーしてコードエディタに貼り付けるか、[Select OpenAPI File (OpenAPI ファイルの選択)] を選択してローカルドライブから OpenAPI ファイルを読み込みます。

  4. [設定] の [エンドポイントタイプ] で、[Edge optimized] を選択します。

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

AWS CLI を使用してエッジ最適化 API をインポートする

AWS CLI を使用して、OpenAPI 定義ファイルから API をインポートすることで新しいエッジ最適化 API を作成するには、import-rest-api コマンドを以下のように使用します。

aws apigateway import-rest-api \ --fail-on-warnings \ --body 'file://path/to/API_OpenAPI_template.json'

または、endpointConfigurationTypes クエリ文字列パラメータを EDGE に明示的に指定します。

aws apigateway import-rest-api \ --endpointConfigurationTypes 'EDGE' \ --fail-on-warnings \ --body 'file://path/to/API_OpenAPI_template.json'

API Gateway REST API を使用してエッジ最適化 API をインポートする

API Gateway REST API を使用して、OpenAPI 定義ファイルをインポートすることでリージョン API を作成するには、以下の restapi:import リンクリレーションを呼び出します。

POST /restapis?mode=import&failonwarnings=true Host: apigateway.us-west-2.amazonaws.com Content-Type:application/json Content-Length: ... { //OpenAPI definition }

または、endpointConfigurationTypes クエリ文字列パラメータを EDGE に明示的に指定します。

POST /restapis?mode=import&failonwarnings=true&endpointConfigurationTypes=EDGE Host: apigateway.us-west-2.amazonaws.com Content-Type:application/json Content-Length: ... { //OpenAPI definition }