从 OpenAPI 规范生成 JSDoc

Posted 2023-03-31

【中文标题】从 OpenAPI 规范生成 JSDoc

【英文标题】：Generating JSDoc from OpenAPI Spec

【发布时间】：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 没有提供帮助，我也没有在 *** 上看到太多内容。

除了为此实施我自己的包之外，还有其他人有什么建议吗？

【参考方案1】：

This 包会从你的招摇中为你生成代码，不完全是你所追求的，但可能值得研究。

【讨论】：

谢谢！那个包裹是一个很好的开始。使用 handlebars.js 进行模板化最终是一个很好的解决方案，并且该包有一些很好的样板代码可供我参考。再次感谢！