Aws lambda 如何使用serverless aws documentation插件为serverless生成带标记的swagger文档
我正在使用无服务器aws文档插件自动生成swagger文档。遵循以下位置提供的所有步骤:。在documentation key下,我定义了标记,但它并没有在output swagger文档中生成。以下是示例处理程序:Aws lambda 如何使用serverless aws documentation插件为serverless生成带标记的swagger文档,aws-lambda,swagger,serverless-framework,Aws Lambda,Swagger,Serverless Framework,我正在使用无服务器aws文档插件自动生成swagger文档。遵循以下位置提供的所有步骤:。在documentation key下,我定义了标记,但它并没有在output swagger文档中生成。以下是示例处理程序: functions: get_tickets: handler: handler.ticket_handler.get_tickets events: - http: path: tickets method:
functions:
get_tickets:
handler: handler.ticket_handler.get_tickets
events:
- http:
path: tickets
method: get
cors: true
documentation:
tags:
- private
- admin
summary: "Get list of ticket"
description: "This ticket will provide you list of tickets"
我想根据标签来划分API,但无法实现。提前感谢您的帮助。您使用的是哪个版本 根据他们的最新文档,您需要提供如下标签,即双引号内的标签
documentation:
tags:
- "private"
- "admin"
尝试在serverless.yml中添加
serverless aws文档
插件
plugins:
- serverless-aws-documentation
在自定义部分添加infor和models文档:
custom:
myStage: ${opt:stage, self:provider.stage}
profiles:
dev: road-we-go
prod: road-we-
documentation:
info:
version: "1.0.0"
name: "Example API"
description: "Example API description"
termsOfService: "https://example.com/terms-of-service"
contact:
name: "Example API"
url: "https://example.com"
email: "dev@example.com"
licence:
name: "Licensing"
url: "https://example.com/licensing"
models:
-
name: "StoreAudioSuccess"
description: "Model for store audio"
contentType: "application/json"
schema: ${file(swagger/audios/storeResponse.
添加函数文档:
如果要添加自定义模型,如RequestStore
和StoreAudioSuccess
请查看serverless aws文档和json模式
要下载swagger文档,需要运行以下命令:
首先,您需要部署您的项目
成功了吗?我仍然无法得到招摇文件上的标签。。。
functions:
Update:
handler: src/functions/update.handler
timeout: 30
memory: 128
events:
- http:
method: put
private: true
cors: true
path: api/v1/update
documentation:
summary: "Update "
description: "Update a record"
tags:
- "Users"
requestModels:
"application/json": "RequestStore"
methodResponses:
-
statusCode: "200"
responseModels:
"application/json": "StoreUserSuccess"
sls downloadDocumentation --outputFileName=swagger.json