spring-restdocs的研究

该框架经过单元测试来生成REST接口的说明文档,详见Spring REST Docsspring

  1. 能够对参数和返回值进行说明,还能产生url和返回用例
  2. 经过完善单元测试,和目前的mockMvc框架相结合,能够产生Asciidoctor文档片断
  3. 目前只能产生片断,集成文档须要手动写,集成文档默认放在src\main\asciidoc路径下
  4. 默认产生的是Asciidoctor片断,能够选择Markdown(oschina上用的是这种格式)
  5. 测试用例越多越完善,文档就越详尽(例子更多)
  6. 比起传统的Java Docs生成文档的方式,可更加深刻
相关文章
相关标签/搜索