apigcc-maven-plugin

Introduction: easy use apigcc with maven
More: Author   ReportBugs   
Tags:

Download

easy use apigcc with maven

install

<plugin>
    <groupId>com.github.apiggs</groupId>
    <artifactId>apiggs-maven-plugin</artifactId>
    <version><!-- 替换为上方版本号 --></version>
    <executions>
        <execution>
            <phase>compile</phase>
            <goals>
                <goal>apiggs</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <!-- options in there -->
    </configuration>
</plugin>

when you compile source code, apiggs will build rest doc.

options

  1. id 项目 id,生成 id.html 文件
  2. title 文档标题
  3. description 文档描述
  4. production 输出文件夹,默认为 apiggs
  5. out 输出目录,默认为 target
  6. source 源码目录
  7. dependency 源码依赖的代码目录,以逗号隔开
  8. jar 源码依赖的 jar 包目录,以逗号隔开
  9. ignore 忽略某些类型
  10. version 文档版本号
Apps
About Me
GitHub: Trinea
Facebook: Dev Tools