node.js - 从 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 文件。

注意:请注意，生成的 swagger 规范将仅包含您的路由、方法和路径参数。