如何记录节点打字稿 AWS 无服务器 API？

Question

My team is working on a new API using the Serverless aws-nodejs-typescript template.

In previous APIs we've used the aws or openAPI plugin for Serverless in order to document our APIs. However, we find it cumbersome since it requires an extra effort after development and implementation. Also it might become outdated whenever the team drops the bar regarding keeping it up to date.

We would like to use some kind of annotations similar to springdoc-openapi-ui for Java. I've seen there exists a Typescript Swagger package , however it seems to be right choice when not using Serverless(AWS) but for instance Express .

Has anyone used or found the right tooling to document Serverless AWS lambda APIs using Node and Typescript?

Any suggestion or hint will be more than welcomed!

Thanks!

Answer 1

您可以尝试使用此链接中的插件serverless-aws-documentation我解释了如何使用它