为用Express 4.x编写的API创建Swagger-docs

Create Swagger-docs for API written in Express 4.x

本文关键字:API 创建 Swagger-docs Express 为用      更新时间:2023-09-26

我有一个用Node和Express 4编写的服务器。我也有一个客户,他想把这个和Swagger一起记录下来。如何做到这一点?

我研究了以下工具:

  • swagger-node-express:让你做我想做的,除了它不支持Express 4.x
  • Swagger 2.0 - Node-Express-4。x:和上面一样,只是方法不同。可以使用,除了我没有找到很多关于设置它的文档(我太慢了,没有文档)

如果我从头开始,像swaggerize-express和Swaggers自己的Node工具就可以工作,但我只是想要一种方法来轻松地将文档添加到我的项目中,以便Swagger可以读取它。

从长远来看,写一个Swagger可以读取的文档文件是行不通的,因为这样我就必须更新它。我想记录代码中的所有内容,而不是一个Swagger-或自述文件,并让文档通过Swagger- ui自动提供。

我可能在这里忽略了一些东西,但我似乎找不到任何可以帮助我的东西。欢迎提出任何建议。

我强烈推荐使用环回框架。它是用于在立体模型上创建REST api的框架。它在底层使用Express,由StrongLoop公司创建,该公司现在也自己维护Express项目。

支持Swagger开箱即用