从Mocha / Chai测试套件生成swagger / openapi文档

Question

我想使用Swagger/OpenAPI来标准化文档工作。大多数API都是使用NodeJS构建的，我与Mocha＆Chai进行了集成测试，这有助于快速确保进行更改后API不会被破坏。据我了解，使用Swagger不会取代我的集成测试，但可以使开发人员轻松知道如何使用我的API。如果我可以将文档工作与我的测试套件结合在一起，它将使正在进行的文档维护更加容易。添加或修改测试时，可以在同一位置更新API文档。

我正在考虑使用YUIDoc或JSDoc来从源注释生成API文档。但是都不符合OpenAPI规范。然后我发现Swagger-JSdoc并认为我可以将所有注释放入测试套件代码中，因为我已经在其中指定了要在端点中测试的内容。

对于新项目或现有项目，是否还有另一种方式/工作流程可能更有效？如何使文档工作更接近测试套件，以改善正在进行的文档维护？

Answer 1

我刚刚发布了npm module。不知道是否找到了替代方案，如果找不到，请随时尝试。 https://github.com/LmntrX/mocha-swagger/

使用

全局安装mocha-swagger

npm install -g mocha-swagger

然后执行以下命令：

mocha-swagger path/to/project/tests

此命令将递归地解析测试目录中的测试文件，并在当前目录中生成基本的 swagger.json 文件。

注意：请注意，生成的详细规格将仅包含您的路线，方法和路径参数。