smart-doc-maven-plugin 插件的使用
pom 中添加插件
<plugin> <groupId>com.github.shalousun</groupId>
<artifactId>smart-doc-maven-plugin</artifactId>
<version>1.0.0</version> <configuration> <!--指定生成文档的使用的配置文件-->
<configFile>./src/main/resources/smart-doc.json</configFile> <!--指定项目名称-->
<projectName>测试</projectName>
</configuration>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>html</goal>
</goals>
</execution>
</executions>
</plugin>
在自己的项目中创建一个json配置文件，smart-doc-maven-plugin插件会根据这个配置生成项目的接口文档。目录/src/main/resources/smart-doc.json。配置内容参考如下。
{ "serverUrl": "http://127.0.0.1", //设置服务器地址,非必须 "isStrict": false, //是否开启严格模式 "allInOne": true, //是否将文档合并到一个文件中，一般推荐为true "outPath": "D://md2", //指定文档的输出路径 "coverOld": true, //是否覆盖旧的文件，主要用于mardown文件覆盖 "packageFilters": "",//controller包过滤，多个包用英文逗号隔开 "md5EncryptedHtmlName": false,//只有每个controller生成一个html文件是才使用 "projectName": "smart-doc",//配置自己的项目名称 "skipTransientField": true,//目前未实现 "dataDictionaries": [ //配置数据字典，没有需求可以不设置 { "title": "订单状态", //数据字典的名称 "enumClassName": "com.power.doc.enums.OrderEnum", //数据字典枚举类名称 "codeField": "code",//数据字典字典码对应的字段名称 "descField": "desc"//数据字典对象的描述信息字典 } ], "errorCodeDictionaries": [{ //错误码列表，没有需求可以不设置 "title": "title", "enumClassName": "com.power.doc.enums.ErrorCodeEnum", //错误码枚举类 "codeField": "code",//错误码的code码字段名称 "descField": "desc"//错误码的描述信息对应的字段名 }], "revisionLogs": [ //设置文档变更记录，没有需求可以不设置 { "version": "1.0", //文档版本号 "status": "update", //变更操作状态，一般为：创建、更新等 "author": "author", //文档变更作者 "remarks": "desc" //变更描述 } ], "customResponseFields": [ //自定义添加字段和注释，api-doc后期遇到同名字段则直接给相应字段加注释，非必须 { "name": "code",//覆盖响应码字段 "desc": "响应代码",//覆盖响应码的字段注释 "value": "00000"//设置响应码的值 } ], "requestHeaders": [ //设置请求头，没有需求可以不设置 { "name": "token", "type": "string", "desc": "desc", "required": false, "since": "-" } ], "sourceCodePaths": [ //设置代码路径，默认加载src/main/java, 没有需求可以不设置 { "path": "src/main/java", "desc": "测试" } ]}
maven Helper插件选择生成何种文档.
注意： controller 层的函数需要添加/***/样式的函数注释 并且不能有空值 ，其他的实体类中的字段描述也要使用相同的注释方式。
导出结果
