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

【问题标题】：How to document Node typescript AWS serverless API?如何记录节点打字稿 AWS 无服务器 API？
【发布时间】：2021-02-06 08:50:39
【问题描述】：

我的团队正在使用Serverless aws-nodejs-typescript 模板开发新的 API。

在之前的 API 中，我们使用了用于无服务器的 aws 或 openAPI 插件来记录我们的 API。但是，我们发现它很麻烦，因为它需要在开发和实施之后付出额外的努力。此外，每当团队降低保持其最新状态的标准时，它也可能会变得过时。

我们想为 Java 使用一些类似于 springdoc-openapi-ui 的注解。我已经看到存在 Typescript Swagger package，但是当不使用无服务器（AWS）但例如 Express 时，它似乎是正确的选择。

是否有人使用或找到了正确的工具来使用 Node 和 Typescript 记录无服务器 AWS lambda API？

欢迎任何建议或提示！

谢谢！

【问题讨论】：

【解决方案1】：

你可以尝试使用插件serverless-aws-documentation 在这个link 中我会解释如何使用它

【讨论】：

正如问题描述中所述，我们在以前的项目中使用过它，但它很麻烦。我目前的目标不是记录无服务器文件，而是记录代码本身。无论如何感谢您的提示。
我想我误解了这个问题，如果记录我们的 api 的时间很长，有时甚至很烦人，我见过一些使用无服务器和 NestJS 的同事，从他们的评论来看，这更舒服，因为他们不用生成模型等等等等，只是编码，但我并没有真正使用过