Swagger没有为`Node.js`项目生成API文档,为什么?

时间:2016-02-18 15:11:07

标签: node.js rest swagger swagger-2.0 swagger-editor

Swagger规范文档不是从Swagger作为子项目集成到Node.js项目中生成的。但是,SwaggerUI已启动并正在运行。如果我们提供说swagger.json或api-docs.json文件,那么它将呈现指定的REST API calls。 我的要求是为现有项目生成API文档。我该怎么做 ?

1 个答案:

答案 0 :(得分:0)

请参阅this answer以获取有关如何为项目生成Swagger文档的帮助。

您可以手动为API创建文档并让Swagger UI为其提供服务,也可以使用像swagger-node-express这样的节点包,它将自动完成大部分文档管理。请参阅上面的链接,了解每个选项的优缺点。