在 API Gateway 中建立產品 REST 端點 - Amazon API Gateway
建立產品 REST 端點

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

在 API Gateway 中建立產品 REST 端點

產品 REST 端點是您入口網站產品的存取點。每個端點都包含 REST API 的路徑和方法，以及其部署所在的階段。端點包含您為 REST API 定義的任何文件，也可以使用自訂文件進行更新。當您建立產品 REST 端點時，您可以設定下列設定：

  • 產品 REST 端點的操作名稱。如果您的 REST API 具有路徑和方法 GET /pets，在入口網站中，名稱為 /pets。您可以使用 操作名稱，將產品 REST 端點名稱變更為 Pet summaries。這不會影響您現有的 API。

  • 適用於您產品端點的 try it 功能。這可讓 API 消費者在您的APIs。如果您為私有 API 建立產品端點，則 try it 功能會設為 UNAVAILABLE。如需詳細資訊，請參閱針對入口網站中的 API Gateway 產品 REST 端點啟用試用。

  • 如果您目前有為 REST API 定義的文件組件，您可以匯入文件或覆寫現有的文件，並使用 GitHub Flavored Markdown 建立新的產品層級文件。任何文件覆寫都不會傳播回您的 API Gateway API 文件組件。如果您匯入目前的文件組件，API Gateway 會跨 API 同步變更至您的產品 REST 端點。

建立產品 REST 端點

下列程序說明如何將產品 REST 端點新增至現有的入口網站產品。若要了解如何同時建立入口網站產品和產品 REST 端點，請參閱 在 API Gateway 中建立入口網站產品。

為產品入口網站建立產品 REST 端點

  1. 在以下網址登入 API Gateway 主控台：https://console.aws.amazon.com/apigateway。

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

  3. 選擇入口網站產品。

  4. 選擇關聯的端點索引標籤，然後選擇新增端點。

  5. 若要選取您的產品 REST 端點，請在 API 端點下選擇 API，然後選擇階段。

  6. 若要將端點新增至您的產品 REST 端點，請選取 API 端點，然後選擇新增至產品。

    API 端點會出現在選取的 API 端點清單中。

  7. 選擇提交。

  8. 您的產品 REST 端點頁面現在是草稿。選擇草稿 API 參考頁面，然後選擇您的產品 REST 端點頁面，以完成頁面的內容。

  9. 選擇編輯頁面。

  10. 若要覆寫現有的 API Gateway 文件，請針對文件來源開啟覆寫文件並執行下列動作：

    1. 針對顯示內容，選擇建立覆寫。

    2. 針對操作名稱，輸入新的操作名稱。

    3. 在頁面內文中，輸入您的自訂文件。

    4. （選用） 針對端點，輸入入口網站中顯示的自訂端點。

  11. 若要讓客戶在您的入口網站中叫用您的 API，請選取試用功能。如需詳細資訊，請參閱針對入口網站中的 API Gateway 產品 REST 端點啟用試用。

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

  13. 選擇儲存變更。

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