如何解决当通过 SAM 使用 HttpApi 时,OpenApi 定义是否是事实的单点?
我花了一天时间来加快 SAM 的速度,尤其是 HttpApi,但遇到了困难。这就是我想要实现的(梦想):
- 在 Open API 3(合同)中创建 REST API
- 将 api.yaml 传递给 HttpApi 并让它为 api 生成所有样板
- 现在我的 api 文档和我的 api 路由总是相同的(根据合同),感觉很温暖
- 将 Open API 规范交给前端人员和后端人员,让他们在中间很好地相遇
我很确定无论如何它应该是这样工作的。但这就是让我困惑的地方。我正在将集成添加到我的 api.yaml 中,例如:
get:
summary: get item
tags:
- Items
responses:
'200':
description: Item returned successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ItemResource'
'404':
$ref: '#/components/responses/NotFound'
x-amazon-apigateway-integration:
payloadFormatVersion: "2.0"
type: "aws_proxy"
httpMethod: "POST"
uri:
Fn::GetAtt [GetItemFunction,Arn]
connectionType: "INTERNET"
现在我期待使用这个 HttpApi 将我的 OpenApi 文件中的路由与我在集成“GetItemFunction”中指向的 Lambda 连接起来。所以我可以像这样定义我的 Lambda:
GetItemFunction:
Type: AWS::Serverless::Function
Properties:
CodeUri: src/
Handler: get-item.handler
Runtime: nodejs12.x
但这似乎没有按预期设置路由(我正在使用“sam local start-api”进行测试)。为了让它工作,我需要这样做:
GetItemFunction:
Type: AWS::Serverless::Function
Properties:
CodeUri: src/
Handler: get-item.handler
Runtime: nodejs12.x
Events:
GetAllItems:
Type: HttpApi
Properties:
ApiId: !Ref MyHttpApi
Path: /items/{id}
Method: get
这可行,但现在我在 template.yaml 文件中定义路由,而不是在 api.yaml 文件中定义路由,这对于我的用例来说是失败的。无论我是否在 api.yaml 中添加“x-amazon-apigateway-integration”,它的行为似乎也完全相同。
我确定我在这里遗漏了一些东西,如果有人能让我走上正确的道路,我将不胜感激!
解决方法
当您使用事件源在 SAM 中声明连接时,SAM 会创建权限。如果您不使用事件源,则 SAM 不会构建权限,并且 API 网关无权调用 Lambda 函数。如果您想手动构建它,请在 SAM 模板中创建一个角色。这是一个工作示例(简化为一个模板):
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Description: OpenAPI test
Resources:
MyHttpApi:
Type: AWS::Serverless::HttpApi
Properties:
DefinitionBody:
openapi: "3.0.1"
info:
title: "OpenAPI test"
paths:
/:
get:
responses:
default:
description: Item returned successfully
x-amazon-apigateway-integration:
payloadFormatVersion: "2.0"
credentials: !GetAtt MyHttpApiRole.Arn
type: "aws_proxy"
httpMethod: "POST"
uri: !GetAtt GetItemFunction.Arn
connectionType: "INTERNET"
x-amazon-apigateway-importexport-version: "1.0"
MyHttpApiRole:
Type: "AWS::IAM::Role"
Properties:
AssumeRolePolicyDocument:
Version: "2012-10-17"
Statement:
- Effect: "Allow"
Principal:
Service: "apigateway.amazonaws.com"
Action:
- "sts:AssumeRole"
Policies:
- PolicyName: ApiDirectWriteToSQS
PolicyDocument:
Version: '2012-10-17'
Statement:
Action:
- lambda:InvokeFunction
Effect: Allow
Resource:
- !GetAtt GetItemFunction.Arn
GetItemFunction:
Type: AWS::Serverless::Function
Properties:
CodeUri: src/
Handler: app.handler
Runtime: nodejs12.x
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。