📄SpringDoc：接口文档新方式
1. 引入依赖
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.8.14</version>
</dependency>
2. 访问接口
http://server:port/context-path/v3/api-docs
3. 非侵入式
| swagger | springdoc | javadoc |
|---|---|---|
| @Api(name = "xxx") | @Tag(name = "xxx") | java类注释第一行 |
| @Api(description= "xxx") | @Tag(description= "xxx") | java类注释 |
| @ApiOperation | @Operation | java方法注释 |
| @ApiIgnore | @Hidden | 无 |
| @ApiParam | @Parameter | java方法@param参数注释 |
| @ApiImplicitParam | @Parameter | java方法@param参数注释 |
| @ApiImplicitParams | @Parameters | 多个@param参数注释 |
| @ApiModel | @Schema | java实体类注释 |
| @ApiModelProperty | @Schema | java属性注释 |
| @ApiModelProperty(hidden = true) | @Schema(accessMode = READ_ONLY) | 无 |
| @ApiResponse | @ApiResponse | java方法@return返回值注释 |
4. 进阶改造
引入 javadoc 相关依赖；
<!-- Runtime library -->
<dependency>
<groupId>com.github.therapi</groupId>
<artifactId>therapi-runtime-javadoc</artifactId>
<version>0.15.0</version>
</dependency>
<!--Annotation processor -->
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<annotationProcessorPaths>
<path>
<groupId>com.github.therapi</groupId>
<artifactId>therapi-runtime-javadoc-scribe</artifactId>
<version>0.15.0</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
</plugins>
</build>
5. apifox整合
1. 批量导入
2. 基于插件实时更新
安装插件
IDEA 搜索 apifox
开通令牌
打开apifox客户端，在账户设置界面创建令牌
配置令牌
上传接口
修改于 2025-11-25 14:14:45