apiggs-maven-plugin

easy use apiggs with maven.

License	MIT License
Categories	Maven Build Tools
GroupId	com.github.apiggs
ArtifactId	apiggs-maven-plugin
Last Version	1.6
Release Date	Nov 8, 2018
Type	maven-plugin
Description	apiggs-maven-plugin easy use apiggs with maven.
Project URL	https://github.com/apiggs/apiggs-maven-plugin
Source Code Management	https://github.com/apiggs/apiggs-maven-plugin.git

Download apiggs-maven-plugin

Filename	Size
apiggs-maven-plugin-1.6.pom
apiggs-maven-plugin-1.6.jar	6 KB
apiggs-maven-plugin-1.6-sources.jar	1 KB

How to add to project

Apache Maven

<plugin>
    <groupId>com.github.apiggs</groupId>
    <artifactId>apiggs-maven-plugin</artifactId>
    <version>1.6</version>
</plugin>

Dependencies

compile (4)

Group / Artifact	Type	Version
org.apache.maven : maven-core	jar	3.5.4
org.apache.maven : maven-plugin-api	jar	3.5.4
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.5.2
com.github.apiggs : apiggs	jar	1.6

Project Modules

There are no modules declared in this project.

apiggs-maven-plugin

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 文档版本号

Versions

Version
1.6 Nov 8, 2018
1.5 Oct 31, 2018
1.4 Oct 29, 2018
1.3 Oct 29, 2018
1.2 Oct 29, 2018
1.1 Oct 24, 2018
1.0 Oct 23, 2018