代码拉取完成,页面将自动刷新
用法
项目暂时还没有上传到中央仓库需要先执行下面的几个命令,把apidoc4j安装到本地
git clone https://github.com/liuyuyu/apidoc4j
cd apidoc4j
mvn clean install -Dmaven.test.skip=true
然后创建自己的工程
在pom.xml中增加
<plugin>
<groupId>cn.xiaocuoben</groupId>
<artifactId>apidoc4j-maven-plugin</artifactId>
<version>1.0-SNAPSHOT</version>
<configuration>
<!-- 你的包名,如果cn.xiaocuoben不包含你不想引入的包,那就不要用cn.xiaocuoben.apidoc4j -->
<basePackage>cn.xiaocuoben.apidoc4j.sample</basePackage>
<output>${project.basedir}/apidoc.md</output>
<resources>
<!-- 源码目录,多模块项目就配置多个 -->
<resource>${project.build.sourceDirectory}</resource>
<resource>${project.parent.basedir}\apidoc4j-sample-common\src\main\java</resource>
</resources>
</configuration>
</plugin>
然后在项目目录执行
apidoc4j:generate
如果你的项目有像apidoc4j-sample一样的依赖关系,最好现在你工程的根目录执行一次
mvn clean install
就会在项目的根目录生成apidoc.md文件
支持框架:SpringMVC
生成格式
截图
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。