swagger3注解的变化
前言
最近使用上了swagger3,发现以前swagger2的注解都没有了,复制过来还不能直接用,下面记录下变化
常用注解
swagger3的注解包路径为io.swagger.v3.oas.annotations
| swagger2 | swagger3 | 注解位置 |
|---|---|---|
| @Api | @Tag | Controller类 |
| @ApiOperation(value = “foo”, notes = “bar”) | @Operation(summary = “foo”, description = “bar”) | api端口方法 |
| @ApiImplicitParams | @Parameters | api端口方法 |
| @ApiImplicitParam | @Parameter | api方法的参数 |
| @ApiParam | @Parameter | api方法的参数 |
| @ApiIgnore | @Parameter(hidden = true) 或 @Operation(hidden = true) 或 @Hidden | 各处皆可 |
| @ApiModel | @Schema | DTO类 |
| @ApiModelProperty | @Schema | DTO属性 |
| @ApiModelProperty(hidden = true) | @Schema(accessMode = READ_ONLY) | DTO属性 |
| @ApiResponse(code = 404, message = “foo”) | @ApiResponse(responseCode = “404”, description = “foo”) | api端口方法 |