使用 API Gateway 主控台設定 API 整合請求

API 方法設定會定義方法並描述其行為。若要設定方法，您必須指定資源，包括公開方法的根目錄 ("/")、HTTP 方法 (GET、POST 等等)，以及與目標後端整合的方法。方法請求和回應會指定呼叫應用程式的合約，規定 API 收到哪些參數以及回應的外觀。

下列程序說明如何使用 API Gateway 主控台來建立整合請求。

設定 Lambda 整合

使用 Lambda 函數整合，將您的 API 與 Lambda 函數整合。在 API 層級，如果您建立非代理整合，則這會是 AWS 整合類型，如果您建立代理整合，則這會是 AWS_PROXY 整合類型。

設定 Lambda 整合

1. 在資源窗格中，選擇建立方法。

2. 針對方法類型，選取 HTTP 方法。

3. 對於 Integration type (整合類型)，請選擇 Lambda function (Lambda 函數)。

4. 若要使用 Lambda 代理整合，請開啟 Lambda 代理整合。若要深入了解 Lambda 代理整合，請參閱 了解 API Gateway Lambda 代理整合。

5. 針對 Lambda 函數，輸入 Lambda 函數的名稱。

   如果您在與 API 不同的區域中使用 Lambda 函數，請從下拉式選單中選取區域，並輸入 Lambda 函數的名稱。如果您使用的是跨帳戶 Lambda 函數，請輸入函數 ARN。

6. 若要使用 29 秒的預設逾時值，請將預設逾時保持開啟。若要設定自訂逾時，請選擇預設逾時，然後輸入介於 50 和 29000 毫秒之間的逾時值。

7. (選用) 您可以使用下列下拉式選單來配置方法請求設定值。選擇方法請求設定，並設定您的方法請求。如需詳細資訊，請參閱 在 API Gateway 主控台編輯 API Gateway 方法請求 的步驟 3。

   您也可以在建立方法後配置方法請求設定值。

8. 選擇建立方法。

設定 HTTP 整合

使用 HTTP 整合將您的 API 與 HTTP 端點整合。在 API 層級，這是 HTTP 整合類型。

設定 HTTP 整合

1. 在資源窗格中，選擇建立方法。

2. 針對方法類型，選取 HTTP 方法。

3. 對於整合類型，選擇 HTTP。

4. 若要使用 HTTP 代理整合，請開啟 HTTP 代理整合。若要進一步了解 HTTP 代理整合，請參閱 在 API Gateway 中設定 HTTP 代理整合。

5. 針對 HTTP method (HTTP 方法)，選擇最符合 HTTP 後端中方法的 HTTP 方法類型。

6. 針對端點 URL，輸入您希望此方法使用之 HTTP 後端的 URL。

7. 針對內容處理，選取內容處理行為。

8. 若要使用 29 秒的預設逾時值，請將預設逾時保持開啟。若要設定自訂逾時，請選擇預設逾時，然後輸入介於 50 和 29000 毫秒之間的逾時值。

9. (選用) 您可以使用下列下拉式選單來配置方法請求設定值。選擇方法請求設定，並設定您的方法請求。如需詳細資訊，請參閱 在 API Gateway 主控台編輯 API Gateway 方法請求 的步驟 3。

   您也可以在建立方法後配置方法請求設定值。

10. 選擇建立方法。

設定 AWS 服務整合

使用 AWS 服務整合以將您的 API 直接與 AWS 服務整合。在 API 層級，這是 AWS 整合類型。

若要設定 API Gateway API，請執行下列任一個動作：

• 建立新 Lambda 函數。

• 在 Lambda 函數上設定資源許可。

• 執行任何其他 Lambda 服務動作。

您必須選擇 AWS 服務。

設定 AWS 服務整合

1. 在資源窗格中，選擇建立方法。

2. 針對方法類型，選取 HTTP 方法。

3. 對於整合類型，選擇 AWS 服務。

4. 針對 AWS Region (AWS 區域)，選擇您希望此方法用來呼叫動作的 AWS 區域。

5. 針對 AWS 服務，選擇您希望此方法呼叫的 AWS 服務。

6. 針對 AWS 子網域，輸入 AWS 服務使用的子網域。這個項目一般會保持空白。有些 AWS 服務可支援子網域做為主機的一部分。請參閱服務文件以了解可用性及詳細資訊 (如有)。

7. 針對 HTTP method (HTTP 方法)，選擇對應動作的 HTTP 方法類型。如需 HTTP 方法類型，請參閱您為 AWS 服務選擇之 AWS 服務的 API 參考文件。

8. 針對動作類型，選取使用動作名稱以使用 API 動作，或選取使用路徑覆寫以使用自訂資源路徑。如需可用的動作和自訂資源路徑的資訊，請參閱您為 AWS 服務選擇之 AWS 服務的 API 參考文件。

9. 輸入動作名稱或路徑覆寫。

10. 針對執行角色，輸入方法將用於呼叫動作之 IAM 角色的 ARN。

    若要建立 IAM 角色，您可以調整 步驟 1：建立 AWS 服務代理執行角色 中的指示。指定以下格式的存取政策，包含所需動作數和資源陳述式：

    {
      "Version": "2012-10-17",
      "Statement": [
        {
          "Effect": "Allow",
          "Action": [
            "action-statement"
          ],
          "Resource": [
            "resource-statement"
          ]
        },
        ...
      ]
    }  

    如需動作和資源陳述式語法，請參閱您為 AWS 服務選擇之 AWS 服務的文件。

    如需 IAM 角色的信任關係，請指定以下動作，讓 API Gateway 代表您的 AWS 帳戶採取行動：

    {
      "Version": "2012-10-17",
      "Statement": [
        {
          "Sid": "",
          "Effect": "Allow",
          "Principal": {
            "Service": "apigateway.amazonaws.com"
          },
          "Action": "sts:AssumeRole"
        }
      ]
    }

11. 若要使用 29 秒的預設逾時值，請將預設逾時保持開啟。若要設定自訂逾時，請選擇預設逾時，然後輸入介於 50 和 29000 毫秒之間的逾時值。

12. (選用) 您可以使用下列下拉式選單來配置方法請求設定值。選擇方法請求設定，並設定您的方法請求。如需詳細資訊，請參閱 在 API Gateway 主控台編輯 API Gateway 方法請求 的步驟 3。

    您也可以在建立方法後配置方法請求設定值。

13. 選擇建立方法。

設定模擬整合

如果您希望 API Gateway 充當您的後端傳回靜態回應，請使用模擬整合。在 API 層級，這是 MOCK 整合類型。一般而言，當您的 API 尚未到達最終形態，但您希望產生 API 回應解鎖相依小組進行測試時，您可以使用 MOCK 整合。針對 OPTION 方法，API Gateway 會將 MOCK 整合設為預設值，針對已套用的 API 資源傳回 CORS 啟用的標頭。

設定模擬整合

1. 在資源窗格中，選擇建立方法。

2. 針對方法類型，選取 HTTP 方法。

3. 對於整合類型，選擇模擬。

4. (選用) 您可以使用下列下拉式選單來配置方法請求設定值。選擇方法請求設定，並設定您的方法請求。如需詳細資訊，請參閱 在 API Gateway 主控台編輯 API Gateway 方法請求 的步驟 3。

   您也可以在建立方法後配置方法請求設定值。

5. 選擇建立方法。