Maven 编译时生成、纯静态文档、不能调试、零侵入、不用运行项目的api文档

马艳泽2026-04-29 10:04

api 开头、Maven 编译时生成、纯静态文档、不能调试、零侵入、不用运行项目。

我直接给你最简可用完整版配置，复制到 pom 就能用！

一、Maven 插件配置（直接复制）

放到你的 pom.xml → <build> → <plugins> 里

xml

xml 复制代码

<!-- ApiGGs 接口文档生成插件（编译时自动生成静态文档） -->
<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>
        <!-- 文档标题 -->
        <title>XX项目接口文档</title>
        <!-- 文档描述 -->
        <description>SpringBoot 后端接口</description>
        <!-- 版本号 -->
        <version>1.0.0</version>
        <!-- 要扫描的包 -->
        <packages>
            <package>com.你的项目.controller</package>
        </packages>
        <!-- 输出目录：编译后在 target/docs 下 -->
        <out>${project.build.directory}/docs</out>
        <!-- 生成的文档格式：html、markdown、adoc -->
        <format>html</format>
    </configuration>
</plugin>

二、怎么用？

执行 Maven 命令：

plaintext

python 复制代码

mvn compile

编译完成后，打开：

plaintext

bash 复制代码

target/docs/index.html

就是静态接口文档 ，浏览器直接打开，不能调试、纯展示。

三、它的特点（和你描述完全一致）

✅ jar 包 api 开头：apiggs
✅ Maven 编译时生成
✅ 不支持在线调试
✅ 零注解、零配置
✅ 生成纯静态 HTML 文档
✅ 不侵入代码、不影响运行

四、如果你想要【一键生成】

IDEA 右侧：Maven → 你的项目 → plugins → apiggs → apiggs:apiggs双击直接生成文档。