使用 API Gateway 控制台设置方法

在资源窗格中选定方法的情况下，从 Method Execution (方法执行) 窗格中选择 Method Request (方法请求)。

在设置下，选择铅笔图标以打开授权下拉菜单，然后选择一个可用的授权方。

1. 要为任何用户启用开放式访问，请选择 NONE。如果未更改默认设置，则可跳过此步骤。

2. 要使用 IAM 权限来控制客户端访问方法的权限，请选择 AWS_IAM。如果选择此选项，只允许具有已附加正确 IAM 策略的 IAM 角色的用户调用此方法。

   要创建 IAM 角色，请指定类似于以下格式的访问策略：

   {
     "Version": "2012-10-17",
     "Statement": [
       {
         "Effect": "Allow",
         "Action": [
           "execute-api:Invoke"
         ],
         "Resource": [
           "resource-statement"
         ]
       }
     ]
   }  

   在此访问策略中，resource-statement 是授权设置部分中 ARN 字段的值。有关设置 IAM 权限的更多信息，请参阅使用 IAM 权限控制对 API 的访问。

   要创建 IAM 角色，您可以调整使用 Lambda 集成构建 API Gateway REST API的创建 Lambda 函数部分的“创建 Lambda 调用角色及其策略”和“创建 Lambda 执行角色及其策略”中的说明。

   要保存您的选择，请选择 Update (更新)。否则，选择取消。

3. 要使用 Lambda 授权方，请在令牌授权方下选择一个授权方。您必须先创建 Lambda 授权方，此选项才会在下拉菜单中显示。有关如何创建 Lambda 授权方的信息，请参阅 使用 API Gateway Lambda 授权方。

4. 要使用 Amazon Cognito 用户池，请在 Cognito 用户池授权方下选择可用的用户池。您必须在 Amazon Cognito 中创建了一个用户池，并在 API Gateway 中创建了一个 Amazon Cognito 用户池授权方，才能在下拉菜单中显示此选项。有关如何创建 Amazon Cognito 用户池授权方的信息，请参阅 使用 Amazon Cognito 用户池作为授权方控制对 REST API 的访问。

要启用或禁用请求验证，请从 Request Validator (请求验证程序) 下拉菜单中选择铅笔图标，然后选择所列的选项之一。有关各选项的更多信息，请参阅在 API Gateway 中启用请求验证。

如需 API 密钥，请选择铅笔图标以打开 API Key Required (需要的 API 秘钥) 下拉菜单，然后根据您的 API 要求选择 true 或 false。启用后，将在使用计划中使用 API 密钥以限制客户端流量。

要向方法中添加查询字符串参数，请执行以下操作：

1. 选择 URL Query String Parameters (URL 查询字符串参数) 旁边的箭头，然后选择 Add query string (添加查询字符串)。

2. 对于名称，键入查询字符串参数的名称。

3. 选择复选标记图标以保存新查询字符串参数名称。

4. 如果将在请求验证中使用新创建的查询字符串参数，请选择 Required (必填) 选项。有关请求验证的更多信息，请参阅在 API Gateway 中启用请求验证。

5. 如果新创建的查询字符串参数将用作缓存密钥的一部分，请选中 Caching (缓存) 选项。这仅适用于缓存已启用的情况。有关缓存的更多信息，请参阅将方法或集成参数用作索引缓存响应的缓存键。

要向方法中添加标头参数，请执行以下操作：

1. 选择 HTTP Request Headers (HTTP 请求标头) 旁边的箭头，然后选择 Add header (添加标头)。

2. 对于名称，请键入标头参数的名称，然后选择复选标记图标以保存设置。

3. 如果将在请求验证中使用新创建的标头参数，请选择 Required (必填) 选项。有关请求验证的更多信息，请参阅在 API Gateway 中启用请求验证。

4. 如果新创建的标头参数将用作缓存密钥的一部分，请选择 Caching (缓存) 选项。这仅适用于缓存已启用的情况。有关缓存的更多信息，请参阅将方法或集成参数用作索引缓存响应的缓存键。

要声明包含 POST PUT、或 PATCH HTTP 动词的方法请求的负载格式，请展开 Request Body (请求正文)，然后执行以下操作：

1. 选择 Add model (添加模型)。

2. 为 Content type (内容类型) 键入 MIME 类型（例如 application/json）。

3. 打开 Model name (模型名称) 下拉菜单，选择负载的可用模型，然后选择复选标记图标以保存设置。

   该 API 目前可用的模型包括默认 Empty 和 Error 模型以及您创建和添加到 API 的模型集合的任何模型。有关创建模型的更多信息，请参阅在 API Gateway 中创建模型。

   注意

   模型适用于向客户端通知预期数据格式的负载。这对生成骨骼映射模板非常有帮助。请务必使用 Java、C #、Objective-C 和 Swift 等语言编程生成 API 的强类型开发工具包。仅在已针对负载启用请求验证时才需要该开发工具包。

要在由 API Gateway 生成的此 API 的 Java 开发工具包中分配操作名称，请展开开发工具包设置，然后在操作名称中键入名称。例如，对于 GET /pets/{petId} 的方法请求，相对应的默认 Java 开发工具包操作名称为 GetPetsPetId。此名称由此方法的 HTTP 动词 (GET) 和资源路径变量名称 (Pets 和 PetId) 构建而成。如果您将操作名称设置为 getPetById，开发工具包操作名称将变为 GetPetById。

从 API 资源的指定方法的 Method Execution (方法执行) 中选择 Method Response (方法响应)。

要添加新响应，请选择 Add Response (添加响应)。

1. 键入 HTTP 状态代码；例如，为 HTTP Status (HTTP 状态) 键入 200、400 或 500，然后选择复选标记图标以保存选择。

   如果后端返回的响应未定义相应的方法响应，API Gateway 就无法将响应返回给客户端。而是返回 500 Internal server error 错误响应。

2. 展开指定状态代码的响应。

3. 选择 Add Header (添加标头)。

4. 在 Response Headers for {status} 下的名称中键入名称，然后选择复选标记图标以保存选择。

   如果您需要将后端返回的任何标头转换为方法响应中定义的一个标头，则必须先按照此步骤介绍的说明添加方法响应标头。

5. 在 Response Body for {status} 下选择 Add Response Model (添加响应模型)。

6. 为 Content type (内容类型) 键入响应负载的媒体类型，然后从模型下拉菜单中选择模型。

7. 选择复选标记图标以保存设置。

要修改现有的响应，请展开响应，然后按照上面的步骤 2 进行操作。

要删除响应，请选择该响应的 x 图标，并确认您要删除该响应。