SpringBoot 接口文档

apiPost 工具同步后直接可以输出

swigger

apiggs-maven-plugin

1. 基本介绍

   • apiggs - maven - plugin主要用于从 Java 代码生成 API 文档，它可以根据代码中的注释和结构来生成详细的 API 文档，帮助开发人员更好地理解和使用代码。

2. 在 Maven 项目中的配置步骤

   • 步骤一：在项目的 pom.xml 文件中添加插件依赖

     • 在<build>标签内的<plugins>标签中添加以下内容。如果<plugins>标签不存在，需要先创建它。

收起

xml

<plugin>
    <groupId>org.mojohaus.apiggs</groupId>
    <artifactId>apiggs-maven-plugin</artifactId>
    <version>0.5.1</version>
    <executions>
        <execution>
            <goals>
                <goal>doc</goal>
            </goals>
        </execution>
    </executions>
</plugin>

• 这里的<version>标签指定了apiggs - maven - plugin的版本号。你可以根据实际需求在 Maven 仓库中查找最新版本并替换。<executions>标签定义了插件的执行目标，这里指定了doc目标，它用于生成文档。

• 步骤二：配置插件参数（可选）

  • 可以通过<configuration>标签来配置插件的各种参数，例如文档的输出路径、标题等。

收起

xml

<plugin>
    <groupId>org.mojohaus.apiggs</groupId>
    <artifactId>apiggs-maven-plugin</artifactId>
    <version>0.5.1</version>
    <executions>
        <execution>
            <goals>
                <goal>doc</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <outputDirectory>docs/api</outputDirectory>
        <title>My API Documentation</title>
    </configuration>
</plugin>

• 在上述配置中，<outputDirectory>标签指定了生成的 API 文档的输出目录为docs/api，<title>标签指定了文档的标题为My API Documentation。你可以根据自己的项目需求调整这些参数。

• 步骤三：运行插件

  • 在配置好插件后，可以通过 Maven 命令来运行它。在项目的根目录下，打开命令行终端，执行以下命令：

    • mvn apiggs:doc

    • 这个命令会触发apiggs - maven - plugin的doc目标，根据配置生成 API 文档。如果在步骤二中配置了输出目录，文档会生成到指定的目录中。

3. 注意事项

   • 确保项目的 Java 代码有足够的注释来生成有价值的 API 文档。按照 JavaDoc 的规范编写注释可以更好地利用这个插件。
   • 插件的版本可能会影响其功能和兼容性。如果在使用过程中遇到问题，可以尝试更新插件版本或者查看插件的官方文档来解决。