无嵌入api生成工具

2019-03-26  本文已影响0人  小李_a98e
<dependency>
            <groupId>com.github.apiggs</groupId>
            <artifactId>apiggs</artifactId>
            <version>1.6</version>
</dependency>

编码

Environment env = new Environment()
    .id("example")
    .title("示例接口文档")
    .description("示例接口文档,使用默认模板");
new Apiggs(env).lookup().build();

参数说明

id 项目id,生成id.html等文件
title 文档标题
description 文档描述
production 输出文件夹,默认为apiggs
out 输出目录,默认为target
source 源码目录,默认读取当前项目的src/main/java
dependency 源码依赖的代码目录,以逗号隔开
jar 源码依赖的jar包目录,以逗号隔开
ignore 忽略某些类型,如UserDTO
version 文档版本号
css 设置html样式表

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>
        <!-- options in there -->
    </configuration>
</plugin>

tip

执行 mvn compile  需要clean install 时 请把插件注释掉 因为有冲突
上一篇 下一篇

猜你喜欢

热点阅读