API Gateway 入口網站 - Amazon API Gateway

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

API Gateway 入口網站

您可以使用 API Gateway 入口網站,與網頁中的 API 消費者分享您的 APIs 和 API 文件。入口網站包含一組入口網站產品。每個入口網站產品都是 REST APIs 的邏輯分組,其中包含您為 API 取用者建立和發佈的文件。入口網站內的產品頁面包含入口網站產品層級的自訂文件。產品 REST 端點頁面包含每個 REST APIs的文件,以及 REST API 的路徑、方法和階段。產品頁面和產品 REST 端點頁面的組合提供完整的文件,讓 API 消費者了解如何開始使用 REST APIs。

使用入口網站執行下列動作:

  • 將 API Gateway 用於整個 API 生命週期,從建立 APIs到記錄和分發它們。

  • 跨 AWS 帳戶共用入口網站產品。

  • 自訂和共用入口網站產品的中央位置,並提供產品頁面。

考量事項

下列考量事項可能會影響您使用 API Gateway 入口網站:

  • 您只能建立入口網站來共用 REST APIs。

  • 入口網站是在 AWS 區域層級建立。您的入口網站只能包含位於您建立入口網站之相同區域中的 REST APIs。

  • 您只能使用 AWS 管理主控台 AWS CLI、 或 AWS SDKs 來建立和共用您的入口網站。

  • 您只能使用 Amazon Cognito 使用者集區控制對入口網站的存取。您的入口網站消費者可以直接透過使用者集區登入,也可以透過第三方身分提供者 (IdP) 聯合。如果您使用 Amazon Cognito 使用者集區,則無法為您的使用者集區設定用戶端秘密。如需詳細資訊,請參閱 Amazon Cognito 使用者集區