我有一个用Node和Express 4编写的服务器 . 我也有一个客户希望用Swagger记录这个 . 如何才能做到这一点?
我研究了以下工具:
-
swagger-node-express:让您完全按照我的意愿行事,但不支持Express 4.x.
-
Swagger 2.0 - Node-Express-4.x:与上述相同,但采用不同的方法 . 可以使用,但我没有't find much documentation on setting it up (and I'米太慢,没有文档得到它)
如果我从头开始,像swaggerize-express和Swaggers own tool for Node这样的工具会起作用,但我只是想要一种方法来轻松地将文档添加到我的项目中,以便Swagger可以读取它 .
从长远来看,编写一个Swagger可以读取的doc文件是行不通的,因为那时我必须更新它 . 我想记录代码中的所有内容,而不是Swagger或自述文件,并且可以通过Swagger-UI自动获取文档 .
我可能在这里忽略了一些东西,但我似乎找不到任何可以帮助我的东西 . 欢迎提出所有建议 . 提前致谢 .
1 回答
我强烈建议调查Loopback框架 . 它是在立体声系统上创建REST API的框架 . 它在引擎盖下使用Express,由StrongLoop公司创建,现在也保留了Express project .
It supports Swagger out of the box.