我总是习惯使用适当的文档与其他团队共享我的节点端服务.根据此文档,他们将使用我的服务.
关于这一点,当我与其他人交谈时.他建议我用swagger
.但我不知道如何集成到我的应用程序.
我的申请写在Express
.我在谷歌搜索过这个,我没有找到任何好的教程.如果有人已经实施,你能建议我吗?哪个模块好,怎么样.
也很奇怪,他们是否swagger
支持任何其他类似的Node
平台.
谢谢
我有使用快速模块(swagger-node-express
)记录Express API的经验.我也有使用手动Swagger JSON文档记录Express API的经验.
我建议不要将自己绑在Swagger文档的模块上.大多数模块(尤其是swagger-node-express)强迫您以不同方式编写Express代码来处理文档.使用JSON手动编写Swagger文档时,您可以编写Express并从路由中分离文档.
使用Swagger UI设置文档样式并将其添加到您的网页.
以下是您在开始时可以使用的一些资源:
Swagger编辑器 - 编辑您的swagger文档并查看您的更改实时更新
Swagger Docs - Swagger规范的JSON
教程 - 这使用旧版本的Swagger,请务必查看Migrating Swagger以升级到最新版本
另外,看一下这个答案,解释手动和基于模块的swagger doc生成之间的区别 - > HERE.