Generating Swagger YAML from JSDoc?



我有一个用JSDoc完整记录的大型JS API,并且我正在构建一个基于swagger的REST服务,以使API在网络上可用。

我手动构建了YAML swagger规范的初始版本,但问题是它很快就与JS API不同步了,因为它仍在发展,特别是在涉及的对象的属性方面。

我想做的是直接从JSDoc注释自动生成swagger YAML,至少是它的数据定义部分。有没有什么工具可以帮我把它自动化?

swagger-jsdoc可以满足您的需求。

最新更新