

# API Gateway で製品ページを作成する
<a name="apigateway-portals-create-product-page"></a>

製品ページは、製品コンシューマーが製品を理解し、使用するのに役立ちます。ドキュメントは製品レベルであるため、製品が含まれるすべてのポータルにこのドキュメントが含まれます。API Gateway は、[GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) で記述された 2 種類の製品ページをサポートしています。

概要ページ  
製品を作成すると、API Gateway は、製品の作成時に提供した情報に基づいて、製品の **[概要]** ページを自動的に生成します。このページには、変更できない追加のフォーマットがあります。テキストを変更したり、ポータル製品からページを削除したりできます。

カスタムページ  
カスタムページは Markdown で記述されたページです。このセクションは、利用規約や製品の使用方法に関するチュートリアルに使用できます。任意のカスタムページを概要ページに変更できます。カスタムページを概要ページに変更すると、ページの内容は概要ページと一致するようにフォーマットされます。

## 考慮事項
<a name="apigateway-portals-create-product-page-considerations"></a>

以下の考慮事項は、製品ページの使用に影響する可能性があります。
+ このドキュメントは API レベルではなく、メソッド、リソース、またはリクエストパラメータは含まれません。製品の API レベルでドキュメントを変更する方法については、「[API Gateway で製品 REST エンドポイントを更新する](apigateway-portals-update-product-endpoint.md)」を参照してください。
+ `.md` ファイルを製品に直接アップロードすることはできません。
+ ポータル製品の表示順序でページリストを変更することで、製品ページの順序を変更できます。詳細については、「[API Gateway でポータル製品を更新する](apigateway-portals-update-portal-product.md)」を参照してください。
+ ドキュメントの変更を有効にするには、製品を含むポータルを再度公開する必要があります。
+ 同じポータル製品を使用する複数のポータルがある場合、製品ページはすべてのポータルで同じです。同じ製品 REST エンドポイントを持ちながら製品ページが異なる場合は、複数の製品を作成します。

## 製品ページを作成する
<a name="apigateway-portals-create-product-page-create"></a>

次の手順で、製品ページを作成する方法を示します。

**製品ページを作成するには**

1. [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway) で API Gateway コンソールにサインインします。

1. メインナビゲーションペインで、**[ポータル製品]** を選択します。

1. [製品] を選択します。

1. **[ドキュメント]** で、**[カスタムページを作成]** を選択します。

1. **[ページタイトル]** に、ページタイトルを入力します。

1. **[本文]** には、GitHub Flavored Markdown を使用して補足ドキュメントを入力します。

   **[プレビュー]** セクションには、コンテンツがポータルにどのように表示されるかが表示されます。最終的なビジュアルスタイルは、ポータルの設定によって異なる場合があります。

1. **[製品ページの作成]** を選択します。

1. 製品ページがドラフトになりました。**[ドラフトドキュメントページ]** を選択し、製品ページを選択してページの内容を完成させます。

1. **[ページを編集]** を選択します。

1. **[セクション名]** に名前を入力するか、既存のセクションを選択します。製品ページをセクションに追加すると、コンシューマーは公開されたポータルでコンテンツを表示できます。

1. **[Save changes]** (変更の保存) をクリックします。

コンシューマーが新しいページを表示できるようにするには、ポータルを再度公開する必要があります。詳細については、「[API Gateway でポータルを公開する](apigateway-portals-publish-portal.md)」を参照してください。