開始使用 Cloud Endpoints 入口網站

本頁說明如何為您的 Cloud Endpoints 服務建立入口網站,並向您介紹入口網站的使用者介面。本文的範例會針對每項工作,提供完成工作所需的 Cloud Identity & Access Management 最低權限角色 (可能不只單一角色)。如要進一步瞭解 Cloud IAM 權限,請參閱以下內容:

必備條件

本頁假設您已具備以下條件:

建立入口網站

如要建立入口網站,請執行下列操作:

  1. 在 Google Cloud Platform 主控台,前往「Endpoints」>「Developer Portal」(開發人員入口網站) 頁面。

    進入 Cloud Endpoints 入口網站

  2. 選取 API 所屬的 GCP 專案。
  3. 按一下 [Create portal] (建立入口網站)。產生入口網站通常需要 5-10 分鐘的時間。入口網站準備就緒後,畫面上會顯示網站網址。

建立入口網站會造成下列影響:

  • 建立入口網站期間,會建立一個名為 service-YOUR_PROJECT_NUMBER@endpoints-portal.iam.gserviceaccount.com 的服務帳戶,其角色是 Endpoints 入口網站服務代理人。(YOUR_PROJECT_NUMBER 是 GCP 專案的專案編號)。您可以在 GCP 主控台中,GCP 專案的「IAM & admin」(IAM 與管理員) >「IAM」頁面看到這個服務帳戶。

  • 建立入口網站時,您的入口網站使用的網域名稱會是 endpointsportal.YOUR_PROJECT_ID.cloud.goog。(YOUR_PROJECT_ID 是您的 GCP 專案 ID)。為因應這一點,即使您的入口網站並非公開存取網站,也會建立安全資料傳輸層 (SSL)/傳輸層安全標準 (TLS) 憑證和一筆公開 DNS 記錄 (其中包含您的專案 ID),在公開的憑證透明化記錄中即可搜尋到這些資訊。

查看 API 的入口網站

如要查看 API 的入口網站,請執行下列操作:

  1. 在「Endpoints」>「Developer Portal」(開發人員入口網站) 頁面的「Portal URL」(入口網站網址) 區段中按一下網址。
  2. 按照登入提示繼續進入您的入口網站。如果您有多個帳戶,請務必選擇用於 API 所屬 GCP 專案的帳戶。

    入口網站的首頁會隨即顯示。為方便起見,我們建議您將此網址加入書籤。入口網站首頁會顯示 GCP 專案中所有 API 的連結清單。

  3. 按一下您要探索的 API。接著,畫面即會顯示此 API 的首頁。

介紹入口網站的 UI

API 首頁最下方會顯示下列圖示,這些圖示為 API 使用者提供有用的連結。

  • API 參考資料 顯示 Endpoints 入口網站從 openapi.json 檔案 (檔案由 Endpoints Frameworks 建立) 產生的 SmartDocs API 參考說明文件的第一頁。您可以使用左側導覽列查看每種方法和資源的 SmartDocs 說明文件。

  • 開始使用 顯示「入門指南」中的範例內容。將入口網站網址傳送給 API 使用者之前,請自訂這份說明文件,提供 API 使用者開始在其程式碼中使用 API 所需的資訊。如需進一步瞭解如何修改「入門指南」的內容,請參閱新增自訂說明文件

  • 取得金鑰 顯示「APIs & Services」(API 和服務) >「API Library」(API 程式庫) 頁面,讓使用者能夠在自己的 GCP 專案中啟用您的 API。

    若您的 API 規定要有 API 金鑰,則使用者啟用您的 API 之後,即可前往「APIs & Services」(API 和服務) >「Credentials」(憑證) 頁面取得可在程式碼中使用的 API 金鑰。將入口網站網址傳送給 API 使用者之前,必須授予對方使用 API 的存取權。如需詳細資訊,請參閱控管可以啟用 API 的人員

自訂入口網站的外觀

您可以配合公司網站變更入口網站顯示的色彩配置以及圖示。只要變更入口網站的外觀並為其設定自訂網域,您就能夠為使用者打造特別的品牌體驗。

如要自訂入口網站的外觀,請執行下列操作:

  1. 按一下頁面右上角的 [Settings] (設定) settings

  2. 按一下 [Site Wide] (全網站) 分頁標籤。您可以變更下列外觀:

    • 標誌
    • 首頁和標題列背景色彩所用的主色。
    • 圖示和連結色彩所用的輔色。
    • 首頁標題。
    • 首頁說明。
  3. 按一下 [儲存]

刪除入口網站

如要刪除入口網站,請執行下列操作:

  1. 在 GCP 主控台中,進入「Endpoints > 開發人員入口網站」頁面。

    進入 Cloud Endpoints 入口網站

  2. 選取 API 所屬的 GCP 專案。
  3. 按一下 [Delete] (刪除) delete
  4. 在確認對話方塊中,點選 [Delete] (刪除)

後續步驟

瞭解:

本頁內容對您是否有任何幫助?請提供意見:

傳送您對下列選項的寶貴意見...

這個網頁
App Engine 適用的 Cloud Endpoints Frameworks
需要協助嗎?請前往我們的支援網頁