离线生成api文档基于springboot jdk1.8

第一步引入jar包:

<dependency>
			<groupId>com.github.treeleafj</groupId>
			<artifactId>spring-boot-starter-xDoc</artifactId>
			<version>1.0.0</version>
</dependency>

第二步springboot启动加个注解(支持离线下载文档)：

@EnableXDoc

第三步controller 方法名上加上以下注释：

 /**
     * 客户余额接口
     * @param 参数名称 参数描述|参数类型|必填
     * @return 返回类型
     * @resp code 返回码(000表示返回成功,其它表示失败)|String|必填
     * @resp resMessage 是否成功|String|必填
     * @resp data 返回数据体|List|必填
     * @resp total 返回总数|long|必填
     * @respbody 返回json格式数据
     */

第四步启动web 自动扫描注释上的参数 自动生成接口文档访问（http://localhost:web服务端口号/xdoc/index.html）：

离线生成技巧：

//生成离线的HTML格式的接口文档
    String userDir = System.getProperty("user.dir");
    FileOutputStream out = new FileOutputStream(new File(userDir, "接口文档.html"));
    XDoc xDoc = new XDoc(userDir + "控制器路径", new SpringWebFramework());
    xDoc.build(out, new HtmlForamt());