Swagger简介
Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。总体来说,Swagger提供了一套标准的注解,开发者可以通过这些注解来描述他们的API,然后Swagger可以根据这些注解生成可交互的API文档。
swagger2 最常用的5个注解
@Api:修饰整个类,描述Controller的作用
@ApiOperation:描述一个类的一个方法,或者说一个接口
@ApiParam:单个参数描述
@ApiModel:用对象来接收参数
@ApiProperty:用对象接收参数时,描述对象的一个字段
其它若干
@ApiResponse:HTTP响应其中1个描述
@ApiResponses:HTTP响应整体描述
@ApiClass
@ApiError
@ApiErrors
@ApiParamImplicit
@ApiParamsImplicit
swagger3的注解与swagger2相差很多,也兼容了swagger2的注解,区别如下:
swagger2 | swagger3 | 说明 |
---|---|---|
@Api | @Tag | Controller类上 |
@ApiOperation | @Operation | Controller方法上 |
@ApiModel | @Schema | DTO类上 |
@ApiModelProperty | @Schema | DTO方法上 |