转载

apidoc的maven插件，自动生成apidoc.json

插件是用apidoc插件生成文档的，具体使用方式可查看官网： http://apidocjs.com/

该插件不会直接生成APIDOC文档，只会自动生成apidoc.json文件，需要执行 apidoc 命令才可以生成

apidoc.json文件会生成在项目根目录apidoc文件夹下

下载依赖包

可配置MAVEN仓库 https://oss.sonatype.org/content/groups/public

或者

下载源码包进行编译打包: https://gitee.com/qianxunclub/qianxunclub-maven-plugin

git clone https://gitee.com/qianxunclub/qianxunclub-maven-plugin.git

cd qianxunclub-maven-plugin

mvn clean install

编辑pom.xml，引入maven plugin

在项目的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完成

生成api文档

在项目跟目录执行：

apidoc -i apidoc/ -o API文档存放目录/

打开API文档存放目录中的 index.html 即可查看文档。

原文 http://qianxunclub.com/apidocde-mavencha-jian-zi-dong-sheng-cheng-apidoc-json/

正文到此结束

所属分类： Java 编程技术

本文标签： git 实例自动生成 ip HTML plugin pom 代码下载 maven API http 源码配置参数测试插件编译 js XML id 目录 https json IO
版权声明： 本文为互联网转载文章，出处已在文章中说明(部分除外)。如果侵权，请联系本站长删除，谢谢。
本文海报： 生成海报一生成海报二

其他链接

关于本站

本站定位：个人技术类博客

本站作用：写博客、记日志、闲聊扯淡鼓捣技术。

问题交流

apidoc的maven插件，自动生成apidoc.json

下载依赖包

编辑pom.xml，引入maven plugin

开始生成

生成api文档

热门推荐

相关文章

说给你听

本文目录

随机标签

书籍教程

近期评论

网站信息

其他链接

关于本站

问题交流