Tips:喜欢的话可以关注小萌哦~~~
今天小萌给大家推荐的一个开源Java Restful API 文档生成工具,一加【oneplus】、iflytek都在用。所以,自然差不了。
官方简介
smart-doc 是一个 java restful api 文档生成工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释的写,smart-doc 就能帮你生成一个简易明了的 Markdown、Html、AsciiDoc 文档。
如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污染,smart-doc是不错的选择!
最新版本
smart-doc 1.7.7
修改timestamp类型字段创建json示例错误bug。
fix #I1545A 单接口多路径bug。
修改部分url生成部署空格问题。
优化对java.util.concurrent.ConcurrentMap的解析。
开源地址
快速入门
1、Getting started
https://gitee.com/sunyurepository/api-doc-test.git
你可以启动这个Spring Boot的项目,然后访问http://localhost:8080/doc/api.html来浏览smart-doc生成的接口文档。
2、Dependency
com.github.shalousun
smart-doc
1.7.7
test
3、Create a unit test
通过运行一个单元测试来让Smart-doc为你生成一个简洁明了的api文档。
public class ApiDocTest {
/**
* 包括设置请求头,缺失注释的字段批量在文档生成期使用定义好的注释
*/
@Test
public void testBuilderControllersApi() {
ApiConfig config = new ApiConfig();
config.setServerUrl("http://localhost:8080");