在 API Gateway 中叫用其餘 API - Amazon API Gateway

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

在 API Gateway 中叫用其餘 API

若要呼叫已部署的 API,用戶端會將請求提交至 API Gateway 元件服務的 URL 以執行 API (也稱為 execute-api)。

REST API 的基本 URL 格式如下所示:

https://api-id.execute-api.region.amazonaws.com/stage/

其中 api-id 是 API 標識符,區域是 AWS 區域,階段是 API 部署的階段名稱。

重要

在您可以叫用 API 之前,您必須先在 API Gateway 中部署 API。如需部署 API 的指示,請參閱在 API Gateway 中部署其餘 API

獲取 API 的調用網址

您可以使用主控台 AWS CLI、或匯出的 OpenAPI 定義來取得 API 的叫用 URL。

使用控制台獲取 API 的調用 URL

下列程序顯示如何在 REST API 主控台中取得 API 的呼叫網址。

若要使用 REST API 主控台取得 API 的呼叫網址
  1. 在以下網址登入 API Gateway 主控台:https://console.aws.amazon.com/apigateway

  2. 選擇已部署的 API。

  3. 從主導覽窗格選擇階段

  4. 階段詳細資訊下,選擇複製圖示以複製 API 的調用 URL。

    此網址適用於 API 的根資源。

    在建立 REST API 之後,主控台會顯示 API 的調用 URL。
  5. 若要取得 API 中其他資源的 API 叫用 URL,請展開次要導覽窗格下的階段,然後選擇方法。

  6. 選擇複製圖示以複製 API 的資源層級叫用 URL。

    REST API 的資源層級 URL 位於階段的次要導覽窗格下。

取得 API 的叫用網址,使用 AWS CLI

下列程序顯示如何使用取得 API 的呼叫 URL AWS CLI。

若要取得 API 的叫用網址,請使用 AWS CLI
  1. 使用下列命令取得rest-api-id. 此命令返回您的區域中的所有rest-api-id值。如需詳細資訊,請參閱get-rest-apis

    aws apigateway get-rest-apis
  2. 將範例取代為您rest-api-id的範例rest-api-id,將範例 {階段名稱} 取代為 {階段名稱},並以您的區域取代 {region}

    https://{restapi_id}.execute-api.{region}.amazonaws.com/{stage_name}/
使用 API 匯出的 OpenAPI 定義檔案取得 API 的呼叫網址

您也可以結合 API 的已匯出 OpenAPI 定義檔案的hostbasePath欄位來建構根 URL。如需如何匯出 API 的指示,請參閱從 API Gateway 匯出 REST API

呼叫 API

您可以使用瀏覽器、curl 或其他應用程式 (例如 Postman) 來呼叫已部署的 API。

此外,您可以使用 API Gateway 主控台來測試 API 呼叫。測試使用 API 閘道的TestInvoke功能,該功能允許在部署 API 之前進行 API 測試。如需詳細資訊,請參閱 使用 API Gateway 主控台來測試 REST API 方法

注意

引動過程 URL 中的查詢字串參數值不能包含 %%

使用網頁瀏覽器叫用 API

如果您的 API 允許匿名訪問,則可以使用任何 Web 瀏覽器調用任何GET方法。在瀏覽器的地址欄中輸入完整的調用 URL。

對於其他方法或任何需要驗證的呼叫,您必須指定有效負載或簽署要求。您可以在 HTML 頁面後面的指令碼或使用其中一個 AWS SDK 的用戶端應用程式中處理這些問題。

使用捲曲調用 API

您可以在終端中使用 curl 之類的工具來調用 API。下列範例 curl 命令會在 API prod 階段的getUsers資源上叫用 GET 方法。

Linux or Macintosh
curl -X GET 'https://b123abcde4.execute-api.us-west-2.amazonaws.com/prod/getUsers'
Windows
curl -X GET "https://b123abcde4.execute-api.us-west-2.amazonaws.com/prod/getUsers"