Swagger3(OpenApi3)注解与Swagger2注解的映射
Swagger2 | OpenAPI 3 | 注解位置 | 作用 |
---|---|---|---|
@Api | @Tag(name = “接口类描述”) | Controller 类上 | 描述此controller的信息 |
@ApiOperation | @Operation(summary =“接口方法描述”) | Controller 方法上 | 描述此api的信息 |
@ApiImplicitParams | @Parameters | Controller 方法上 | 描述参数信息 |
@ApiImplicitParam | @Parameter(description=“参数描述”) | Controller 方法上 @Parameters 里 | 描述参数信息 |
@ApiParam | @Parameter(description=“参数描述”) | Controller方法的参数上 | |
@ApiIgnore | @Parameter(hidden = true) 或 @Operation(hidden = true)或 @Hidden | 用在各种地方,用于隐藏其api | |
@ApiModel | @Schema | DTO类上 | 用于Entity,以及Entity的属性上 |
@ApiModelProperty | @Schema | DTO属性上 | 用于Entity,以及Entity的属性上 |