使用apiggs自动生成api文档

程序员最讨厌的两件事：一是别人的代码没有文档，二是给自己的代码写文档。

有买卖就有伤害 有需求就有市场，比如swagger就可以自动生成文档，但是swagger是侵入式的，和业务代码混在一起，而apiggs是一个非侵入式的maven插件，可以生成三种格式的文档：

html：api文档

json：可直接导入postman

adoc：一种asciidoc文档，可用文件处理器转换成其它格式文档，如html等

 

使用：

在pom.xml添加以下配置，maven打包时即可生成文档

<plugin>
    <groupId>com.github.apiggs</groupId>
    <artifactId>apiggs-maven-plugin</artifactId>
    <version>1.6</version>
    <executions>
        <execution>
            <phase>compile</phase>
            <goals>
                <goal>apiggs</goal>
            </goals>
        </execution>
    </executions>
    <!--以下配置可选-->
    <configuration>
        <id>api</id>
        <title>接口文档</title>
        <description>api接口文档</description>
        <production>api文档</production>
        <out>..</out>
        <version>1.0.1</version>
    </configuration>
</plugin>

configuration配置说明：

1. id 项目id，生成的html文件名
2. title 文档标题
3. description 文档描述
4. production 输出文件夹，默认为 apiggs
5. out 输出目录，默认为 target
6. source 源码目录（1.6不支持该标签）
7. dependency 源码依赖的代码目录，以逗号隔开
8. jar 源码依赖的jar包目录，以逗号隔开
9. ignore 忽略某些类型
10. version 文档版本号

注：生成的接口文档是pom.xml对应的module下的http接口，对于由多个module构成的项目，如何生成其它module下的api文档，我暂时还没有找到解决方法。

 

参考文档：apigcc-maven-plugin