View a markdown version of this page

在 API Gateway 中建立入口網站產品 - Amazon API Gateway
考量事項建立入口網站產品

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

在 API Gateway 中建立入口網站產品

下列程序說明如何建立入口網站產品。入口網站是入口網站產品的集合。建立入口網站產品後，您可以建立產品 REST 端點和產品頁面。若要了解入口網站產品，請參閱 API Gateway 中的入口網站產品。

考量事項

下列考量可能會影響您建立入口網站產品的方式：

  • 您的入口網站產品可以同時包含私有和公有 REST APIs。試用功能不支援私有 APIs，因此在入口網站中具有視覺化差異。身為入口網站擁有者，您可能需要提供說明的文件。

  • 如果您使用 AWS CLI AWS SDKs建立入口網站產品，您的入口網站將不會有任何產品端點或產品頁面。您需要使用 AWS CLI 或 主控台新增這些資源。若要了解如何建立產品 REST 端點，請參閱 在 API Gateway 中建立產品 REST 端點。若要了解如何建立產品頁面，請參閱 在 API Gateway 中建立產品頁面。

建立入口網站產品

下列程序說明如何建立入口網站產品。

建立入口網站產品

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

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

  3. 選擇建立產品。

  4. 在產品名稱中，輸入入口網站產品的名稱。

  5. 針對產品描述，輸入描述。

  6. 選擇下一步。

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

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

    注意

    在未先選擇新增至產品的情況下，請勿選擇下一步。

    入口網站產品

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

  9. 選擇下一步。

  10. 檢閱您的選擇，然後選擇建立產品。

使用主控台建立入口網站產品後，所有產品頁面和產品 REST 端點頁面都是草稿，不會出現在入口網站中。若要讓消費者看到您的產品頁面和產品 REST 端點頁面，您需要將草稿新增至區段。如果您使用 AWS CLI 或 AWS SDKs 建立入口網站產品，請將草稿新增至 AWS CLI 命令中的 區段。無論您如何將草稿新增至區段，都必須發佈使用入口網站產品的入口網站，消費者才能看見它。

將草稿新增至頁面區段

  1. 您的草稿會列在文件索引標籤中。您的產品頁面有草稿文件頁面，產品 REST 端點頁面有草稿 API 參考頁面。選擇草稿 API 參考頁面。

  2. 選擇草稿 API 參考頁面。

    如果您沒有任何產品 REST 端點，則不會有任何 API 參考頁面草稿。若要了解如何建立產品 REST 端點，請參閱 在 API Gateway 中建立產品 REST 端點。

  3. 選擇編輯頁面。

  4. 在此頁面上，您可以覆寫任何現有的 API 文件組件，或使用 API Gateway 文件。若要允許消費者看到產品 REST 端點頁面的內容，請在區段名稱下輸入名稱。如果這是/pets-GET端點，則頁面名稱可能是 Pets。

  5. 選擇儲存變更。

  6. 您建立的新頁面名稱會顯示在 API 參考頁面區段下方。

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