在 API Gateway 中開發 API - Amazon API Gateway

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

在 API Gateway 中開發 API

本節提供開發 API Gateway API 時所需的 API Gateway 功能的詳細資料。

在開發 API Gateway API 時,您可以決定 API 的許多特性。這些特性取決於 API 的使用案例。例如,您可能只允許特定用戶端呼叫您的 API,或是您可能希望讓所有人都可以使用它。您可能需要 API 呼叫來執行 Lambda 函數、進行資料庫查詢或呼叫應用程式。

創建一個 HTTP API

若要建立可操作的 API,您必須至少有一個路由、整合、階段和部署。

下列範例說明如何建立具有 AWS Lambda 或 HTTP 整合的 API、路由以及設定為自動部署變更的預設階段。

本指南假設您已經熟悉 API Gateway 和 Lambda。如需更詳細的清單,請參閱開始使用API閘道

建立一個 HTTP API,方法是使用 AWS Management Console

  1. 開啟 API Gateway 主控台

  2. 選擇 Create API (建立 API)。

  3. HTTP API 下,選擇 Build (組建)。

  4. 選擇 Add integration (新增整合),然後選擇 AWS Lambda 函數或輸入 HTTP 端點。

  5. Name (名稱) 中,輸入 API 的名稱。

  6. 選擇 Review and create (檢閱和建立)。

  7. 選擇 Create (建立)。

現在您的 API 已準備好叫用。您可以透過在瀏覽器中輸入其叫用 URL 或使用 Curl 來測試您的 API。

curl https://api-id.execute-api.us-east-2.amazonaws.com

使用 AWS CLI 建立一個 HTTP API

您可以使用快速建立來建立具有 Lambda 或 HTTP 整合的 API、預設的全部捕獲路由,以及設定為自動部署變更的預設階段。以下命令使用快速建立來建立與後端的 Lambda 函數整合的 API。

注意

若要叫用 Lambda 整合,API Gateway 必須具有必要的許可。您可以使用以資源為基礎的政策或 IAM 角色來授與 API Gateway 叫用 Lambda 函數的許可。若要深入了解,請參閱 AWS Lambda 開發人員指南中的AWS Lambda 權限

aws apigatewayv2 create-api --name my-api --protocol-type HTTP --target arn:aws:lambda:us-east-2:123456789012:function:function-name

現在您的 API 已準備好叫用。您可以透過在瀏覽器中輸入其叫用 URL 或使用 Curl 來測試您的 API。

curl https://api-id.execute-api.us-east-2.amazonaws.com