代码拉取完成,页面将自动刷新
插件是用apidoc插件生成文档的,具体使用方式可查看官网:http://apidocjs.com/
该插件不会直接生成APIDOC文档,只会自动生成apidoc.json文件,需要执行apidoc
命令才可以生成
apidoc.json文件会生成在项目根目录apidoc文件夹下
在项目的pom文件中引入以下:
<plugin>
<groupId>com.qianxunclub</groupId>
<artifactId>qianxunclub-plugin-apidoc</artifactId>
<version>0.0.1-SNAPSHOT</version>
<executions>
<execution>
<goals>
<goal>apidoc</goal>
</goals>
</execution>
</executions>
</plugin>
在properties
定义API的生成规范:
<properties>
<apidoc.skip>false/</apidoc.skip>
<apidoc.gen>false</apidoc.gen>
<apidoc.url>http://ip:port/</apidoc.url>
<apidoc.sampleUrl>http://ip:port/</apidoc.sampleUrl>
</properties>
apidoc.skip:编译代码是否跳过生成apidoc.json
apidoc.gen:是否覆盖更新apidoc.json
apidoc.url:实例接口前缀
apidoc.sampleUrl:生成测试方法的请求地址
执行命令:
mvn clean package
可以添加以下参数:
mvn clean package -Dapidoc.skip=true
-Dapidoc.skip=true:编译代码是否跳过生成apidoc.json
-Dapidoc.gen=true:是否覆盖更新apidoc.json
-Dapidoc.url=xxx:实例接口前缀
-Dapidoc.sampleUrl=xxx:生成测试方法的请求地址
如果出现以下字样,说明生成完成:
apidoc.json完成
在项目跟目录执行:
apidoc -i apidoc/ -o API文档存放目录/
打开API文档存放目录中的index.html
即可查看文档。
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。