文章/答案/技术大牛

发布

社区首页 >问答首页 >如何在SAM中启用"ApiKeyRequired“属性而不需要显式的swagger定义？

问如何在SAM中启用"ApiKeyRequired“属性而不需要显式的swagger定义？
EN

Stack Overflow用户

提问于 2018-10-22 19:02:42

回答 1查看 1.9K关注 0票数 4

在cloudformation中，AWS::ApiGateway::Method具有一个布尔属性ApiKeyRequired。我如何在SAM中实现同样的目标？

我知道我们可以使用显式的swagger配置来启用。就像这样

    {
    "swagger": "2.0",
    "info": {
        "version": "1.0",
        "title": {
              "Ref": "AWS::StackName"
            }
    },
    "x-amazon-apigateway-api-key-source": "HEADER",
    "paths": {
        "/": {
            "get": {
                "x-amazon-apigateway-integration": {
                    "httpMethod": "POST",
                    "type": "aws_proxy",
                    "uri": {
                    "Fn::Sub": "arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${GetHelloWorld.Arn}/invocations"
                  }
                },
                "responses": {},
                "security": [
                    {
                        "api_key": []
                    }
                ]
            }
        }
    },
    "securityDefinitions": {
        "api_key": {
            "type": "apiKey",
            "name": "x-api-key",
            "in": "header"
        }
    }
}

不能在SAM中使用隐式API调用而不是显式传递AWS::Serverless::Api吗？因为swagger代码可以使用较少的端点，并且随着端点的增加而变得复杂。有像APIkeyRequired一样的Cloudformation旗子吗？

任何帮助都是非常感谢的

aws-api-gateway

aws-sam-cli

aws-serverless

aws-sam

回答 1

Stack Overflow用户

回答已采纳

发布于 2020-05-27 17:51:58

现在，SAM中的ApiKeyRequired在AWS::Serverless::Api和AWS::Serverless::Function级别都得到了支持。

以下是AWS文档中的一个示例：

Resources:
  MyApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      Auth:
        ApiKeyRequired: true # sets for all methods

  MyFunction:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: .
      Handler: index.handler
      Runtime: nodejs8.10
      Events:
        ApiKey:
          Type: Api
          Properties:
            RestApiId: !Ref MyApi
            Path: /
            Method: get
            Auth:
              ApiKeyRequired: true

您还可以从以下资源了解此信息：

AWS官方文档这里。
本演练博客帖子由Sarthak。

票数 0

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/52936126

复制

相似问题

问如何在SAM中启用"ApiKeyRequired“属性而不需要显式的swagger定义？
EN

回答 1

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何在SAM中启用"ApiKeyRequired“属性而不需要显式的swagger定义？EN

回答 1

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何在SAM中启用"ApiKeyRequired“属性而不需要显式的swagger定义？
EN