API Gateway で製品 REST エンドポイントを作成する
製品 REST エンドポイントは、ポータル製品へのアクセスポイントです。各エンドポイントは、REST API のパスとメソッド、およびデプロイ先のステージで構成されます。エンドポイントには、REST API 用に定義したドキュメントが含まれているか、カスタムドキュメントで更新できます。製品 REST エンドポイントを作成するときは、次の設定を行います。
-
製品 REST エンドポイントのオペレーション名。REST API にパスと
GET /petsメソッドがある場合、ポータルの名前は/petsです。オペレーション名を使用して、製品の REST エンドポイント名をPet summariesに変更できます。これは既存の API には影響しません。 -
製品エンドポイントの [試してみる機能]。これにより、API コンシューマーはポータルで API を試すことができます。プライベート API の製品エンドポイントを作成する場合、[試してみる機能] は
UNAVAILABLEに設定されます。詳細については、「ポータルで API Gateway 製品 REST エンドポイントの「試してみる」を有効にする」を参照してください。 -
現在 REST API 用にドキュメントパーツが定義されている場合は、ドキュメントをインポートするか、既存のドキュメントを上書きして、GitHub Flavored Markdown
を使用して新しい製品レベルのドキュメントを作成できます。ドキュメントの上書きは、API Gateway API ドキュメントパートには反映されません。現在のドキュメントパートをインポートすると、API Gateway は API 全体の変更を製品の REST エンドポイントに同期します。
Create a product REST endpoint
次の手順は、既存のポータル製品に製品 REST エンドポイントを追加する方法を示しています。ポータル製品と製品の REST エンドポイントを一緒に作成する方法については、「API Gateway でポータル製品を作成する」を参照してください。
製品ポータルの製品 REST エンドポイントを作成するには
https://console.aws.amazon.com/apigateway
で API Gateway コンソールにサインインします。 メインナビゲーションペインで、[ポータル製品] を選択します。
ポータル製品を選択します。
[関連エンドポイント] タブを選択し、続いて [エンドポイントを追加] を選択します。
-
製品 REST エンドポイントを選択するには、[API エンドポイント] で API を選択し、ステージを選択します。
製品 REST エンドポイントにエンドポイントを追加するには、API エンドポイントを選択し、[製品に追加] を選択します。
API エンドポイントは、[選択した API エンドポイント] リストに表示されます。
[Submit] を選択してください。
-
製品の REST エンドポイントページがドラフトになりました。[ドラフト API リファレンスページ] を選択し、製品の REST エンドポイントページを選択してページの内容を完成させます。
[ページを編集] を選択します。
-
既存の API Gateway ドキュメントを上書きするには、[ドキュメントソース] で[ドキュメントの上書き] をオンにし、以下を実行します。
[コンテンツを表示する] で、[上書きを作成] を選択します。
[オペレーション名] に、新しいオペレーション名を入力します。
[ページ本文] には、カスタムドキュメントを入力します。
-
(オプション) [エンドポイント] には、ポータルに表示されるカスタムエンドポイントを入力します。
-
顧客がポータルで API を呼び出せるようにするには、[試してみる機能] を選択します。詳細については、「ポータルで API Gateway 製品 REST エンドポイントの「試してみる」を有効にする」を参照してください。
-
[セクション名] に名前を入力するか、既存のセクションを選択します。製品 REST エンドポイントをセクションに追加すると、コンシューマーは公開されたポータルでコンテンツを表示できます。
[Save changes] (変更の保存) をクリックします。
コンシューマーが新しいページを表示できるようにするには、ポータルを再度公開する必要があります。詳細については、「API Gateway でポータルを公開する」を参照してください。
