Swagger2常用注解--简单规整

❀前言

做项目的时间有如白驹过隙，对于有些知识随手就用，却不是很清楚。现在，接口文档对前后端交互尤其重要。今天抽时间对Swagger2的常用注解做简单规整。根据开发习惯，我将从实体类到接口规整。

一：规整

1：用于类

        @Api()                                ——表示这个类是swagger的资源 (用于Controller)

        @ApiModel()                      ——对类进行说明，提供附加信息，(用于实体类)

        @ApiIgnore()                     ——忽略类或方法

2：用于方法、参数、字段

        @ApiOperation()                ——描述http请求方法

        @ApiParam()                      ——用于接口参数说明

        @ApiModelProperty()        ——用于类属性说明

---

二：详细

1：@Api（）

表示类是swagger的资源，常用于Controller层的swagger页面说明。

参数：tags = "描述" ，value = "说明"。  注意：value只在没有tags的情况下生效

@Api(tags = "部门管理",value = "eee")
@RestController
@RequestMapping("/api/v1/dept")
public class DeptController {

对应swagger页面：

 2：@ApiOperation（）

常用于Controller的方法，描述http请求。

参数：value = "方法描述" ，notes = "提示内容"，tags = "重新分组(不常用)"

    @ApiOperation("获取部门列表(带分页)")
    @GetMapping
    public JsonResult selectAllDept(DeptPageDTO deptDTO) {
       return null;
    }

对应swagger页面：

---

3：@ApiParam（）

常用于Controller方法的参数，用来描述参数信息

参数：name = "参数名"，value = "参数说明"，required = "布尔值，是否必填"

    @ApiOperation("获取部门列表(带分页)")
    @GetMapping
    public JsonResult selectAllDept(@ApiParam(name = "部门",value = "部门列表",required =         true) DeptPageDTO deptDTO) {
        return null;
    }

---

4：@ApiModel（）

对类进行说明，常用于接收参数为类的说明

参数：value = "对象名"，description = "描述"，可直接 " "

@ApiModel("填写信息")
public class JournalContentVO {
}

---

5：@ApiModelProperty（）

 对model属性的说明或者数据操作更改，常用于类作为参数的属性描述

参数：value = "字段说明"，name = "重新名字"，dataType ="重新属性类型" ，required = "是否必填"，example = "举例子说明"，hidden = "隐藏"

     /**
     * 模板填写编码
     */
    @ApiModelProperty(value = "模板填写编码")
    private String code;

对应swagger页面

---

 到此结束，不管怎样，经常写才是王道。以上为个人见解，希望帮到大家。如有纰漏，欢迎补充。