【发布时间】:2021-08-10 13:45:02
【问题描述】:
我有一个来自我使用的 API 服务的 OpenAPI 规范(以 swagger.json 文件的形式)。我想加快生成端点的开发过程,最好用 JSDoc 记录它们以保持 VS Code 中的顺利运行。
我找到了几个 JSDoc-to-Swagger/OpenAPI 解析器和 OpenAPI 渲染器,例如:
- https://www.npmjs.com/package/jsdoc-to-oas?activeTab=readme
- https://www.npmjs.com/package/openapi-comment-parser
- https://www.npmjs.com/package/express-jsdoc-swagger
但是,这些包将 JSDoc 作为输入,并将 Swagger / OpenAPI 规范作为输出。我正在寻找相反的方法。 Google 没有提供帮助,我也没有在 StackOverflow 上看到太多内容。
除了为此实施我自己的包之外,还有其他人有什么建议吗?
【问题讨论】:
标签: node.js npm swagger documentation openapi