API Gateway でポータル製品を作成する
次の手順で、ポータル製品を作成する方法を示します。ポータルは、ポータル製品のコレクションです。ポータル製品を作成したら、製品 REST エンドポイントと製品ページを作成します。ポータル製品の詳細については、「API Gateway のポータル製品」を参照してください。
考慮事項
以下の考慮事項は、ポータル製品の作成方法に影響を与える可能性があります。
-
ポータル製品には、プライベート REST API とパブリック REST API の両方を含めることができます。プライベート API は [試してみる機能] ではサポートされていないため、ポータルに視覚的な違いがあります。ポータル所有者は、これを説明するドキュメントを提供する必要がある場合があります。
-
AWS CLI または AWS SDK を使用してポータル製品を作成する場合、ポータルには製品エンドポイントや製品ページはありません。これらのリソースは、AWS CLI またはコンソールを使用して追加する必要があります。製品 REST エンドポイントを作成する方法については、「API Gateway で製品 REST エンドポイントを作成する」を参照してください。製品ページを作成する方法については、「API Gateway で製品ページを作成する」を参照してください。
Create a portal product
次の手順で、ポータル製品を作成する方法を示します。
ポータル製品を作成するには
https://console.aws.amazon.com/apigateway
で API Gateway コンソールにサインインします。 -
メインナビゲーションペインで、[ポータル製品] を選択します。
-
[製品の作成] を選択します。
-
[製品名] に、ポータル製品の名前を入力します。
-
[製品の説明] に、説明を入力します。
-
[次へ] を選択します。
-
製品 REST エンドポイントを選択するには、[API エンドポイント] で API を選択し、ステージを選択します。
-
製品 REST エンドポイントにエンドポイントを追加するには、API エンドポイントを選択し、[製品に追加] を選択します。
注記
最初に [製品に追加] を選択せずに [次へ] を選択しないでください。
API エンドポイントは、[選択した API エンドポイント] リストに表示されます。
-
[次へ] を選択します。
-
選択を確認して、[製品の作成] を選択します。
コンソールを使用してポータル製品を作成すると、すべての製品ページと製品 REST エンドポイントページはドラフトとなり、ポータルに表示されません。製品ページと製品 REST エンドポイントページをコンシューマーに表示するには、ドラフトをセクションに追加する必要があります。AWS CLI または AWS SDK を使用してポータル製品を作成する場合は、AWS CLI コマンドのセクションにドラフトを追加します。ドラフトをセクションに追加する方法にかかわらず、ポータル製品を使用するポータルを公開してコンシューマーに表示する必要があります。
ページセクションにドラフトを追加するには
-
ドラフトは [ドキュメント] タブに表示されます。製品の [ドラフトドキュメントページ] と製品 REST エンドポイントの [ドラフト API リファレンスページ] があります。[ドラフト API リファレンスページ] を選択します。
-
ドラフト API リファレンスページを選択します。
製品 REST エンドポイントがない場合は、ドラフト API リファレンスページはありません。製品 REST エンドポイントを作成する方法については、「API Gateway で製品 REST エンドポイントを作成する」を参照してください。
-
[ページを編集] を選択します。
-
このページでは、既存の API ドキュメントパートを上書きするか、API Gateway ドキュメントを使用できます。製品 REST エンドポイントページの内容がコンシューマーに表示されるようにするには、[セクション名] に名前を入力します。これが
/pets-GETエンドポイントの場合、ページ名はPetsになります。 -
[Save changes] (変更の保存) をクリックします。
-
作成した新しいページ名が [API リファレンスページ] セクションの下に表示されます。
コンシューマーが新しいページを表示できるようにするには、ポータルを再度公開する必要があります。詳細については、「API Gateway でポータルを公開する」を参照してください。
