swagger3注解用法详解.使用文档

时间:2025-03-17 22:53:35

swagger2注解

@Api:修饰整个类,描述Controller的作用
@ApiOperation:描述一个类的一个方法,或者说一个接口
@ApiParam:单个参数描述
 
@ApiModel:用对象来接收参数
@ApiProperty:用对象接收参数时,描述对象的一个字段
 
 
其它若干
@ApiResponseHTTP响应其中1个描述
 
@ApiResponsesHTTP响应整体描述
 
@ApiClass
 
@ApiError
 
@ApiErrors
 
@ApiParamImplicit
 
@ApiParamsImplicit

用 swagger 3 注释替换 swagger 2 注释

(它已经包含在springdoc-openapi-ui依赖项中)。swagger 3
注释的包是.

依赖项:
swagger3只需要一个依赖即可

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>
swagger2到swagger3的变化规则:
@Api@Tag
 
@ApiIgnore@Parameter(hidden = true)@Operation(hidden = true)@Hidden
 
@ApiImplicitParam@Parameter
 
@ApiImplicitParams@Parameters
 
@ApiModel@Schema
 
@ApiModelProperty(hidden = true)@Schema(accessMode = READ_ONLY)
 
@ApiModelProperty@Schema
 
@ApiOperation(value = "foo", notes = "bar")@Operation(summary = "foo", description = "bar")
 
@ApiParam@Parameter
 
@ApiResponse(code = 404, message = "foo")@ApiResponse(responseCode = "404", description = "foo")