2

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

这样做的原因是,我希望文档能够反映,什么是测试的,什么不是。尽管如此,文档应该像swagger生成的文档一样丰富。

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

你使用什么工具,你能推荐任何好的工具吗?

干杯。

编辑:

记录在接口中定义的 API 合同和记录测试场景是有区别的。如果我的文档只包含经过测试的端点和路径,我可以定义我的界面并且只能分发我测试过的部分。

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

4

3 回答 3

0

也许您想要一个BDD框架?例如:

于 2016-02-26T10:18:43.290 回答
0

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

  1. 不需要额外的注释。所有信息均来自JavaDoc
  2. 可以处理 JAX-RS 以及 Spring 注释
  3. 简单的 Maven 集成

Miredot 在您运行时自动生成基于 HTML 的文档mvn test

于 2016-02-26T10:21:40.057 回答
0

Swagger 是一个不错的选择。这是 GitHub 上的一个项目,具有 Maven 集成和许多其他选项以保持其灵活性。

集成指南:swagger-core wiki

更多信息:这里

于 2016-02-26T10:22:05.633 回答