在 API Gateway 中建立產品頁面 - Amazon API Gateway

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

在 API Gateway 中建立產品頁面

產品頁面可協助您的產品消費者了解和使用您的產品。文件位於產品層級,因此包含您產品的任何入口網站都有此文件。API Gateway 支援兩種以 GitHub Flavored Markdown 撰寫的產品頁面類型:

概觀頁面

當您建立產品時,API Gateway 會根據您在建立產品時提供的資訊,自動為您的產品產生概觀頁面。此頁面具有無法變更的其他格式。您可以修改文字或從入口網站產品中移除頁面。

自訂頁面

自訂頁面是以 Markdown 撰寫的頁面。您可以針對條款與條件或如何使用產品的教學使用本節。您可以將任何自訂頁面變更為概觀頁面。當您將自訂頁面變更為概觀頁面時,頁面內容會格式化為符合概觀頁面。

考量事項

下列考量事項可能會影響您使用產品頁面:

  • 本文件不在 API 層級,且不包含任何方法、資源或任何請求參數。若要了解如何修改產品 API 層級的文件,請參閱 在 API Gateway 中更新產品 REST 端點

  • 您無法將.md檔案直接上傳至您的產品。

  • 您可以修改入口網站產品的顯示順序,來修改產品頁面的順序。如需詳細資訊,請參閱在 API Gateway 中更新入口網站產品

  • 您需要重新發佈包含您產品的任何入口網站,文件變更才會生效。

  • 如果您有多個入口網站使用相同的入口網站產品,則所有入口網站的產品頁面都相同。若要擁有相同的產品 REST 端點,但擁有不同的產品頁面,請建立多個產品。

建立產品頁面

下列程序說明如何建立產品頁面。

建立產品頁面
  1. 在以下網址登入 API Gateway 主控台:https://console.aws.amazon.com/apigateway

  2. 在主導覽窗格中,選擇入口網站產品

  3. 選擇產品。

  4. 文件下,選擇建立自訂頁面

  5. 針對頁面標題,輸入頁面標題。

  6. 針對內文,使用 GitHub Flavored Markdown 輸入您的補充文件。

    預覽區段顯示您的內容在入口網站中的顯示方式。最終視覺效果樣式可能會根據您的入口網站設定而變更。

  7. 選擇建立產品頁面

  8. 您的產品頁面現在是草稿。選擇草稿文件頁面,然後選擇您的產品頁面以完成頁面的內容。

  9. 選擇編輯頁面

  10. 針對區段名稱,輸入名稱或選擇現有區段。當您將產品頁面新增至區段時,消費者可以在已發佈的入口網站上檢視您的內容。

  11. 選擇儲存變更

若要允許消費者看見新頁面,您仍然需要重新發佈入口網站。如需詳細資訊,請參閱在 API Gateway 中發佈入口網站