試用 API

除了查看 SmartDocs API 參考說明文件外,開發人員也可以使用「Try this API」(試用這個 API) 面板與您的 API 互動,無須離開 API 說明文件。開發人員可以在您的入口網站傳送要求至您的 API,並查看回應。如果能在您的入口網站試用 API,使用者將可瞭解需要怎麼做才能讓自己的程式碼與您的 API 搭配運作。

如果您的 API 需要 API 金鑰或驗證,您必須對入口網站進行特別設定,讓使用者可與您的 API 互動。本頁面說明您必須執行哪些要求和設定,才能讓開發人員使用「Try this API」(試用這個 API);並會針對每項工作,說明至少要有何種 Cloud Identity and Access Management 角色才能完成該項工作。如要進一步瞭解 Cloud IAM 權限,請參閱以下內容:

必備條件

  • 您必須事先將 API 部署到 App Engine 標準環境。gcloud app deploy 指令會自動在 appspot.com 網域上為 API 建立 DNS 項目,讓 API 可以從 Endpoints 入口網站存取。
  • 如果您的 API 需要 API 金鑰:

  • 如果您的 API 需要驗證:

進行 API Explorer 設定

如果您的 API 需要 API 金鑰和/或 Firebase 或 Auth0 驗證,則必須完成相關設定才能讓使用者試用您的 API。本節說明如何設定 API 金鑰和驗證設定。

設定 API 金鑰

如何在入口網站上設定 API 金鑰:

  1. 在 Google Cloud Platform Console 中,依序前往「APIs & Services」(API 和服務) >「Credentials」(憑證) 頁面。

    前往憑證頁面

  2. 在 GCP Console 視窗頂端的「Project」(專案) 下拉式清單中,選取您要在當中建立 API 的 GCP 專案。

    • 如果您要使用現有的 API 金鑰:

      1. 在您要使用的 API 金鑰旁邊按一下 [Edit API key] (編輯 API 金鑰) edit
      2. 按一下 API 金鑰右側的 [Copy] (複製) content_copy,將 API 金鑰複製到剪貼簿。
      3. 按一下 [Cancel] (取消)。
    • 如果您要建立 API 金鑰:

      1. 按一下 [Create credentials] (建立憑證),然後選取 [API key] (API 金鑰)。
      2. 將金鑰複製到剪貼簿。
      3. 按一下 [Close] (關閉)
  3. 返回入口網站。

  4. 按一下 [Settings] (設定)settings

  5. 按一下 [API] 分頁標籤,然後從下拉式清單中選取您的 API。

  6. 在「APIs Explorer Settings」(API Explorer 設定) 部分的「Google API key」(Google API 金鑰) 欄位中,貼上 API 金鑰。

  7. 按一下 [Save] (儲存)

設定 Firebase

如何設定 Firebase:

  1. 開啟 Firebase 主控台

    • 如果您目前沒有 Firebase 專案:

      1. 按一下 [Add project] (新增專案) 並選取 API 所在的 GCP 專案名稱。
      2. 在「Authentication」(驗證) 資訊卡中,按一下 [Get Started] (開始使用)。
      3. 按一下 [Sign-In Method] (登入方式) 分頁標籤。
      4. 在「Sign-in providers」(登入供應商) 部分中,啟用您要使用的供應商。
      5. 在「Authorized domains」(已授權網域) 區段,按一下 [Add Domain] (新增網域),並新增您的入口網站網域名稱 (例如 endpointsportal.example-api.example.com)。
      6. 按一下 [Web Setup] (網路設定),自訂的程式碼片段隨即會顯示。請將 Firebase 主控台保持開啟,因為您需要在後續步驟使用程式碼片段中的資訊。
    • 如果您目前擁有 Firebase 專案:

      1. 依序前往「Develop」(開發) >「Authentication」(驗證) 頁面。
      2. 按一下 [Sign-In Method] (登入方式) 分頁標籤。
      3. 在「Authorized domains」(已授權網域) 區段,按一下 [Add Domain] (新增網域),並新增您的入口網站網域名稱 (例如 endpointsportal.example-api.example.com)。
      4. 按一下 [Web Setup] (網路設定),自訂的程式碼片段隨即會顯示。請將 Firebase 主控台保持開啟,因為您需要在後續步驟使用程式碼片段中的資訊。
  2. 在瀏覽器上開啟其他分頁,然後前往您的入口網站。

  3. 按一下 [Settings] (設定)settings

  4. 按一下「Settings」(設定) 頁面中的 [API] 分頁標籤,然後從下拉式清單中選取您的 API。

  5. 在「APIs Explorer Settings」(API Explorer 設定) 區段中:

    1. 複製 Firebase 程式碼片段中 apiKey 欄位的值,並貼到「Google API key」(Google API 金鑰) 欄位。
    2. 複製 Firebase 程式碼片段中 authDomain 欄位的值,並貼到「Firebase auth domain」(Firebase 驗證網域) 欄位中。
  6. 按一下 [Save] (儲存)

詳情請參閱 Firebase 說明文件

設定 Auth0

在設定 Auth0 和入口網站時,請使用以下高階工作清單:

工作 1:確定有 Cloud Endpoints 服務適用的 Auth0 API。

工作 2:進行 Auth0 應用程式設定。

工作 3:在入口網站上進行 Auth0 設定。

工作 1:確定有 Endpoints 服務適用的 Auth0 API

  1. 登入 Auth0 資訊主頁
  2. 在左側導覽列中點選 [APIs] (API)。如果有格式為 https://SERVICE_NAMEAPI 目標對象 (其中 SERVICE_NAME 是您的 Endpoints 服務名稱),表示您已建立 API。請繼續進行後續工作以進行 Auth0 應用程式設定。

    如果沒有,請建立 API:

    1. 按一下 [+ Create API] (+ 建立 API)
    2. 輸入名稱。
    3. 在「Identifier」(ID) 欄位中輸入下列格式的網址:https://SERVICE_NAME

      SERVICE_NAME 改為您的 Endpoints 服務名稱。若您不確定服務名稱為何,請參閱取得服務名稱及設定 ID 一文,進一步瞭解如何找出 Endpoints 服務的名稱。

    4. 按一下 [Create] (建立)

工作 2:進行 Auth0 應用程式設定

  1. Auth0 資訊主頁上,按一下左側導覽列中的 [Applications] (應用程式)
  2. 選取您的 Auth0 應用程式,或按一下 [+ Create Application] (+ 建立應用程式) 建立新的應用程式。
  3. 在應用程式的「Settings」(設定) 分頁向下捲動,並將「入口網站的 OAuth 重新導向網址」新增至 [Allowed Callback URLs] (允許的回呼網址) 欄位。「入口網站的 OAuth 重新導向網址」是您的入口網站網址加上 /oauth/redirect (例如 https://endpointsportal.example-api.example.com/oauth/redirect)。

    [Allowed Callback URL] (允許的回呼網址) 欄位接受多個以半形逗號分隔的網址。請確保所輸入的網址結尾不包含 / 字元。

  4. 按一下 [Save Changes] (儲存變更)。

    請將 Auth0「Settings」(設定) 瀏覽器分頁保持開啟,因為您需要在後續步驟使用該分頁中的資訊。

工作 3:在入口網站上進行 Auth0 設定

  1. 在瀏覽器上開啟其他分頁,然後前往您的入口網站。
  2. 按一下 [Settings] (設定)settings
  3. 按一下「Settings」(設定) 頁面中的 [API] 分頁標籤,然後從下拉式清單中選取您的 API。
  4. 在「APIs Explorer Settings」(API Explorer 設定) 區段中:

    1. 複製 Auth0 資訊主頁中「Client ID」(用戶端 ID) 欄位的值,並貼到「Auth0 client ID」(Auth0 用戶端 ID) 欄位中。
    2. 複製 Auth0 資訊主頁中「Domain」(網域) 欄位的值,並貼到「Auth0 domain」(Auth0 網域) 欄位中。
  5. 按一下 [Save] (儲存)

如要進一步瞭解 Auth0 的設定方式,請參閱 Auth0 說明文件的 Auth0 資訊主頁總覽

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

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

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