AWS SAM 在 API Gateway 中指定方法请求

Question

我对 AWS SAM 相当陌生。 我已经使用 AWS Web 控制台实现了一个 API 网关，并在 API 方法请求中指定了主体验证，我想使用 SAM 模板实现同样的目标。 我对如何在 API Gateway SAM 模板中指定方法请求的搜索没有给出与此相关的任何内容。 请问有什么帮助吗？

Answer 1

在此处添加 API 网关验证的完整指南。

下面是来自 SAM template.yaml 的代码片段，用于在示例 API 上添加正文验证。 这里在 API 的 /ping 路径上定义了 PingInput API 模型。 模型包含一个必需参数和一个可选参数。 在没有必需参数的情况下调用 API 将失败。

AuthApiGateway:
     Type: AWS::Serverless::Api
     Properties:
         StageName: Prod
         DefinitionBody:
             swagger: '2.0'
             info:
                 version: '1.0'
                 title: 'AwsRestServiceTemplate'
             paths:
                 /ping:
                     x-amazon-apigateway-any-method:
                         responses: {}
                     post:
                         x-amazon-apigateway-request-validator: 'Validate body' # To specify that the Http Post body needs to be validated
                         parameters:
                             - in: 'body'
                                 name: 'PingInput'
                                 required: true
                                 schema:
                                     $ref: '#/definitions/PingInput'
                         x-amazon-apigateway-integration:
                             httpMethod: post
                             type: aws_proxy
                             uri:
                                 Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${PingFunction.Arn}/invocations
             x-amazon-apigateway-request-validators:
                 Validate body:
                     validateRequestParameters: true
                     validateRequestBody: true
             definitions:
                 PingInput:
                     type: 'object'
                     required:
                         - 'requiredKey'
                     properties:
                         requiredKey:
                             type: 'string'
                         optionalKey:
                             type: 'string'

Answer 2

如果您要配置“授权”，这里是 SAM 模板。

MyApi:
  Type: AWS::Serverless::Api
  Properties:
    StageName: Prod
    Auth:
      DefaultAuthorizer: AWS_IAM
MyFunction:
  Type: AWS::Serverless::Function
  Properties:
    FunctionName: MyFunction
    ...
    Events:
      Post:
        Type: Api
        Properties:
          Path: /compute
          Method: POST
          RestApiId: !Ref MyApi
          Auth:
            Authorizer: AWS_IAM

您必须在AWS::Serverless::Api定义中定义授权方并在函数中使用它。

参考：

https://github.com/awslabs/serverless-application-model/blob/master/examples/2016-10-31/api_aws_iam_auth/template.yaml

https://github.com/awslabs/serverless-application-model/blob/master/examples/2016-10-31/api_cognito_auth/template.yaml