从单元测试生成REST-API文档

Question

我想自动记录我的REST-API。我知道，这方面有很多工具，但我想从我的单元测试中生成文档。

这样做的原因是，我希望文档能够反映出哪些是经过测试的，哪些不是。尽管如此，文档应该与由昂首阔步生成的文档一样丰富。

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

你用什么工具，你能给出好的建议吗？

干杯。

编辑：

在记录API契约(在接口中定义)和记录测试场景之间有一个区别。如果我的文档只包括测试过的端点和路径，我就能够定义我的接口，并且只能分发我测试过的部分。

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

Answer 1

也许你想要一个BDD框架？例：

• 黄瓜
• 适者生存
• J.表现

Answer 2

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

1. 不需要额外的注释。所有信息都是从JavaDoc中提取的。
2. 可以处理JAX-RS和Spring注释
3. 容易集成

当您运行mvn test时，Miredot会自动生成基于HTML的文档。

Answer 3

昂首阔步是个不错的选择。这是一个关于GitHub的项目，有Maven集成和大量其他选项来保持它的灵活性。

集成指南：自吹自擂

更多信息：这里