Java 从unittests生成REST-API文档

我想自动记录我的REST-API。我知道，有很多工具可以实现这一点，但我想从单元测试生成文档

这样做的原因是，我希望文档能够反映测试的内容和未测试的内容。尽管如此，文档应该像我们所说的由生成的文档一样丰富

我已经找到了两个使用这种方法的项目，并且。两者都不能满足我的需要。生成的文档不会聚合快乐路径和错误路径

你用什么工具？你能推荐一个好的吗

干杯

编辑：

记录接口中定义的API合同和记录测试场景之间存在差异。如果我的文档只包含测试的端点和路径，那么我可以定义我的接口，并且只能分发我已经测试过的部分

这意味着我能够定义一个有十个端点的接口。在通过相应的测试实现了基本功能之后，我可以通过文档发布这个部分。尚未稳定或未实现的端点未包括在内，这会阻止用户使用它们。

也许您想要一个框架？例如：

---

我最近对同一主题进行了一些研究，并决定使用的免费版本，因为它是满足我要求的唯一工具：

不需要额外的注释。所有信息都是从JavaDoc中提取的

可以处理JAX-RS和Spring注释

轻松maven集成

---

当您运行

mvn测试时，Miredot会自动生成一个基于HTML的文档。它是GitHub上的一个项目，具有Maven集成和大量其他选项以保持灵活性

集成指南：

更多信息：
不，我考虑过，但这不是我想要的。它们不是API文档的合适工具，不能包含发送的请求和接收的响应。没错，swagger生成了结构良好的文档，但它不是来自测试。它将接口作为文档的来源，这是一个很大的区别。Swagger记录了合同，而我想要的是实际测试案例的文档。没错，文档是在测试步骤中生成的，但它指的是合同定义，而不是测试。这里是Miredotter。。我只是想确认一下。Miredot在编译步骤之后钩住maven生命周期。运行
mvn测试
可以确保Miredot也能运行。我们只关注代码、注释和Javadoc，而不是测试。