我想使用Swagger/OpenAPI标准化文档工作 . 在进行更改后，大多数API都被破坏了 . 据我所知，使用Swagger不会取代我的集成测试，但会让开发人员更容易知道如何使用我的API . 如果我可以将我的文档工作量集中到我的测试套件中，那么它将使得正在进行的文档维护更容易 . 当我添加或修改测试时，我可以在同一个地方更新API文档 .
我正在考虑做的是使用YUIDoc或JSDoc，它从源代码中的注释生成API文档 . 但都不符合OpenAPI规范 . 然后我发现了Swagger-JSdoc并认为我可以将所有注释放在我的测试套件代码中，因为我已经在那里指定要在 endpoints 中测试的内容 .
是否存在可能对新项目或现有项目更有效的另一种方式/工作流程？如何将我的文档工作更接近我的测试套件以改进正在进行的文档维护？
1 回答
我刚刚发布了一个npm module . 不确定您是否找到了替代品，如果没有，请随意试一试 . https://github.com/LmntrX/mocha-swagger/
全局安装mocha-swagger
然后执行以下命令：
此命令将递归地解析测试目录中的测试文件，并在当前目录中生成基本的swagger.json文件 .
注意：请注意，生成的swagger规范仅包含您的路由，方法和路径参数 .