spring-restdocs的研究

該框架經過單元測試來生成REST接口的說明文檔,詳見Spring REST Docsspring

  1. 能夠對參數和返回值進行說明,還能產生url和返回用例
  2. 經過完善單元測試,和目前的mockMvc框架相結合,能夠產生Asciidoctor文檔片斷
  3. 目前只能產生片斷,集成文檔須要手動寫,集成文檔默認放在src\main\asciidoc路徑下
  4. 默認產生的是Asciidoctor片斷,能夠選擇Markdown(oschina上用的是這種格式)
  5. 測試用例越多越完善,文檔就越詳盡(例子更多)
  6. 比起傳統的Java Docs生成文檔的方式,可更加深刻
相關文章
相關標籤/搜索