在 API Gateway 中建立入口網站 - Amazon API Gateway

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

在 API Gateway 中建立入口網站

入口網站是 產品的集合。您可以控制入口網站的授權、品牌和發佈。當您建立入口網站時,其發佈狀態為 Disabled。這表示您的入口網站無法在 Web 上探索。若要讓消費者存取您的入口網站,您需要發佈它。在發佈入口網站之前,您也可以預覽入口網站。

API Gateway 支援下列瀏覽器上的入口網站:

  • Firefox

  • Google Chrome

  • Microsoft Edge

  • Safari

選擇網域名稱

根據預設,您的入口網站 URL 託管於下列 Amazon 擁有的網域名稱:

https://p-portalId.apigw-portal.us-east-1.on.aws

若要自訂網域名稱,您可以提供您擁有的網域名稱和自訂網域的 SSL 憑證。憑證必須在美國東部 AWS Certificate Manager(維吉尼亞北部) 使用 (ACM) 進行管理,並由 Amazon CloudFront 支援。如需詳細資訊,請參閱搭配 CloudFront 使用 SSL/TLS 憑證的要求

當您使用自訂網域名稱時,API Gateway 會建立 CloudFront 分佈,以 ACM 憑證保護傳輸中。然後,API Gateway 會提供別名記錄,您將其新增至 DNS 組態。別名記錄是 Amazon 擁有的網域名稱。您必須新增此別名記錄,才能將流量導向自訂網域的 CloudFront 分佈。您提供的網域名稱必須是唯一的,且尚未由現有 CloudFront 分佈上的別名清單使用。

如果您使用自己的網域名稱,API Gateway 會使用TLS_1_2安全政策來保護您的入口網站。如需詳細資訊,請參閱檢視器之間支援的通訊協定和密碼。您無法變更此值。

建立入口網站

您可以使用 API Gateway 主控台來建立和設定入口網站。下列程序會引導您完成所有必要的步驟。您也可以選擇跳至檢閱,並在第一個程序結束時建立 ,以建立空白入口網站。

下列程序說明如何建立入口網站。首先,定義您的入口網站詳細資訊。

定義您的入口網站詳細資訊
  1. 在以下網址登入 API Gateway 主控台:https://console.aws.amazon.com/apigateway

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

  3. 選擇 Create portal (建立入口網站)

  4. 在入口網站詳細資訊下,針對入口網站名稱輸入名稱。

  5. 對於入口網站描述,輸入描述。

  6. 針對入口網站授權,選取如何授權您的入口網站。

    • 如果這是您第一次建立入口網站,建議您選擇。如果您打算將任何生產 APIs 新增至入口網站,請使用需要授權

    • 若要要求入口網站消費者驗證以使用您的入口網站,請選擇需要授權,然後執行下列動作:

      1. 針對 Amazon Cognito 使用者集區,選取您的使用者集區。

        使用者集區必須與入口網站位於相同的區域。

      2. 針對應用程式用戶端 ID,選擇應用程式用戶端 ID。

        在您的應用程式用戶端中,您必須將回呼 URL 設定為入口網站的預設 URL。

      3. 對於使用者集區網域,輸入使用者集區網域。如需詳細資訊,請參閱設定使用者集區網域

  7. 針對網域組態,選取入口網站的網域名稱。

    • 如果這是您第一次建立入口網站,我們建議您選擇預設網域。發佈入口網站後,即可在 取得https://p-portalId.apigw-portal.us-east-1.on.aws

    • 若要提供您擁有的自訂網域名稱,請選取自訂網域名稱並執行下列動作:

      1. 針對網域名稱,輸入完整網域名稱。

      2. 針對 ACM 憑證,選擇涵蓋網域名稱的 ACM 憑證。

        您需要將 API Gateway 佈建的別名記錄新增至 DNS 記錄,以便從入口網站提供流量。

  8. 若要將 CloudWatch RUM 應用程式監視器新增至入口網站,請在 RUM 應用程式監視器中選擇應用程式監視器。如需詳細資訊,請參閱 CloudWatch RUM

  9. 選擇下一步

定義入口網站詳細資訊後,您可以新增入口網站產品。您可以隨時變更入口網站中的入口網站產品,但您需要重新發佈入口網站,變更才會生效。

選取您的入口網站產品
  1. 從資源清單中,選取要新增至入口網站的產品。

  2. 選擇下一步

選取產品後,您可以自訂入口網站設計。若要上傳入口網站標誌,您必須將映像上傳至 Amazon S3。您可以隨時變更這些值,但您需要重新發佈入口網站,變更才會生效。

(選用) 自訂您的入口網站
  1. 對於入口網站標誌,請提供 檔案的 S3 URI。

    .jpg支援 .png.svg或 。

  2. 若要自訂入口網站的設計,您有兩個選項:

    1. 您可以選擇入口網站佈景主題,在入口網站上套用預先製作的顏色佈景主題。

    2. 您可以使用顏色選擇器來選取所有入口網站設計選項。

  3. 選擇下一步

選取入口網站設計後,請檢閱入口網站的資訊。

檢閱您的入口網站
  • 在檢閱和建立頁面上檢閱您的設定。當您滿意設定時,請選擇 Create (建立)

如果您使用 Amazon Cognito 使用者集區來控制對入口網站的存取,則必須在應用程式用戶端中將回呼 URL 設定為入口網站的預設 URL。如需詳細資訊,請參閱應用程式用戶端的應用程式特定設定

在您建立入口網站之後,消費者將無法使用該入口網站。您必須發佈入口網站,才能在網際網路上存取。如需詳細資訊,請參閱在 API Gateway 中發佈入口網站