Swagger2 常用注解使用及其说明

目录

Swagger2 常用注解使用及其说明

1、 Api

2、 ApiModel

3、 ApiModelProperty

4、 ApiParam

5、 ApiOperation

6、 ApiResponse 和 ApiResponses

7、 ApiImplicitParam 和 ApiImplicitParams

---

Swagger2 常用注解使用及其说明

1、 Api

@Api 用在类上，说明该类的作用。可以标记一个 Controller 类作为 Swagger 文档资源。

2、 ApiModel

@ApiModel 用在类上，表示对类进行说明，用于实体类中的参数接收说明。

@Api(tags = "BookController")
@Controller
@ApiModel(value = "com.lishaoyu.BookReview.controller.BookController" ,description = "图书控制类")
public class BookController {
  

3、 ApiModelProperty

@ApiModelProperty() 用于字段，表示对 model 属性的说明。