7 Star 10 Fork 1

Gitee 极速下载 / apidoc4j

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
此仓库是为了提升国内下载速度的镜像仓库,每日同步一次。 原始仓库: https://github.com/liuyuyu/apidoc4j.git
该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README

这是一个生成API文档的maven插件

用法

项目暂时还没有上传到中央仓库需要先执行下面的几个命令,把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

生成格式

生成结果示例

截图

参数 返回值

特性

  • maven插件
  • springMVC支持
  • JSON支持
  • 生成markdown

空文件

简介

取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/mirrors/apidoc4j.git
git@gitee.com:mirrors/apidoc4j.git
mirrors
apidoc4j
apidoc4j
master

搜索帮助