注解比较
注解代码位于 io.swagger.v3.oas.annotations
包里。
swagger 2 | swagger 3 |
---|---|
@Api | @Tag 或者 Tags |
@ApiIgnore | @Parameter(hidden = true) 或 @Operation(hidden = true) 或 @Hidden |
@ApiImplicitParam | @Parameter |
@ApiImplicitParams | @Parameters |
@ApiModel | @Schema |
@ApiModelProperty | @Schema |
@ApiOperation(value = “foo”, notes = “bar”) | @Operation(summary = “foo”, description = “bar”) |
@ApiParam | @Parameter |
@ApiResponse(code = 404, message = “foo”) | @ApiResponse(responseCode = “404”, description = “foo”) |
注解说明
一. 作用于类
1. @Tag
用于说明或定义的标签。也可以作用于方法上
部分参数:
- name:名称
- description:描述
2. @Hidden
某个元素(API操作、实体类属性等)是否在 API 文档中隐藏。
3. @ApiResponse
API 的响应信息。也可以作用于方法上,一般常用于方法上
部分参数:
- responseCode:响应的 HTTP 状态码
- description:响应信息的描述
- content:响应的内容
代码