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

时间:2016-02-26 10:06:29

标签: java rest unit-testing api-doc

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

这样做的原因是,我希望文档能够镜像,测试什么以及什么不是。然而,文档应该像让我们说swagger所生成的文档一样丰富。

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

你使用什么工具,你能推荐一个好的工具吗?

干杯。

修改

记录接口中定义的API合同和记录测试方案之间存在差异。如果我的文档仅包含经过测试的端点和路径,我可以定义我的界面,并且只能分发我测试过的部分。

这意味着我可以定义一个界面,让我们说十个端点。在使用相应的测试实现基本功能后,我可以使用文档发布此部分。不包括不稳定或已实现的端点,这会阻止用户使用它们。

3 个答案:

答案 0 :(得分:0)

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

答案 1 :(得分:0)

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

  1. 不需要额外的注释。所有信息都从JavaDoc中提取
  2. 可以处理JAX-RS以及Spring注释
  3. 简单的maven集成
  4. 当您运行mvn test

    时,Miredot会自动生成基于HTML的文档

答案 2 :(得分:0)

Swagger是一个很好的选择。它是GitHub上的一个项目,具有Maven集成和大量其他选项以保持灵活性。

整合指南:swagger-core wiki

更多信息:here