swagger2接口文档注解详解

1、@Api(value = "", description = "")

此注解应用在类上面，表示对类的说明。其中，

（1）tags="说明该类的作用，可以在UI界面上看到的注解" （非空时将覆盖value的值）

（2）value="说明类的作用"

（3）description="说明类的作用，对类的作用进行描述"（1.5版本后将不在支持）

2、@ApiOperation(notes = "", value = "")

此注解作用在方法上面，说明该方法的用途等

（1）value="说明该方法的作用和用途"

（2）notes="对该方法的备注信息说明"

3、@ApiImplicitParams

此注解作用在类上，表明对一组参数的说明

@ApiImplicitParam 用在@ApiImplicitParams注解的内部，表明对一组参数的各个方面进行具体的说明

（1）name参数名

（2）value对参数的说明

（3）required参数是否必传（值为true或者false）

（4）dataType参数类型，默认是String，其他例如：Integer

（5）paramType 参数放在什么地方

·        header --> 请求参数的获取：@RequestHeader ·

         query --> 请求参数的获取：@RequestParam ·

         path（用于restful接口）--> 请求参数的获取：@PathVariable ·

        body（不常用） ·

        form（不常用）

4、@ApiResponses：用在请求的方法上，表示一组响应

    @ApiResponse用在@ApiResponses中，常用于表示一组错误的信息的响应

   （1）code错误代码

   （2）massege错误信息提示

   （3）response 抛出异常的类

    示例：

@ApiResponses({
            @ApiResponse(code=400,message="请求参数没填好"),
            @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
        })

5、@ApiParam用在请求方法中，描述参数的信息

   name参数名称，参数名称可以覆盖方法参数名称，路径参数必须与方法参数一致
   value参数的简要说明。
   defaultValue参数默认值
   required  属性是否必填，默认为false [路径参数必须填]

    示例：
         @ResponseBody
         @PostMapping(value="/login")
         @ApiOperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
         public UserModel login(@ApiParam(name = "name", value = "用户名", required = false) @RequestParam(value = "name", required = false) String account,
                @ApiParam(name = "pass", value = "密码", required = false) @RequestParam(value = "pass", required = false) String password){}

6、@ApiIgnore用在类或者方法上，表明在swagger2中忽略这个类或者方法或者参数。