API Gateway で製品 REST エンドポイントを更新する
製品 REST エンドポイントを更新すると、REST API のパスとメソッド、およびデプロイ先のステージを除き、製品エンドポイントのすべての設定を変更できます。製品エンドポイントの変更は自動的に更新されますが、ポータルに反映された変更を確認するには、製品を使用するポータルを再公開する必要があります。
製品 REST エンドポイントを更新する
次の手順は、製品の REST エンドポイントを更新して、現在の API ドキュメントをカスタム API リファレンスドキュメントで上書きする方法を示しています。
製品 REST エンドポイントを更新するには
https://console.aws.amazon.com/apigateway
で API Gateway コンソールにサインインします。 メインナビゲーションペインで、[ポータル製品] を選択します。
[製品] を選択します。
[ドキュメント] タブの [API リファレンスページ] で、[/dogs - GET] などの製品 REST エンドポイントの名前を選択します。
[プレビュー] で、[ページを編集] を選択します。
[ドキュメントソース] で、[ドキュメントの上書き] を有効にします。
[コンテンツを表示する] で、[既存のコンテンツを上書きする] を選択します。
[すべてのコンテンツの削除] を選択すると、コンテンツはページから削除されますが、[既存のコンテンツを上書き] を選択してドキュメントに再度アクセスできます。
[ページ本文] に、GitHub Flavored Markdown
を使用してカスタム API リファレンスドキュメントを入力します。 このドキュメントは API Gateway には反映されません。
[Save changes] (変更の保存) をクリックします。
変更を有効にするには、このポータル製品を使用するポータルを再公開する必要があります。