swagger常用注解

1、@Api()；

        作用于类，生成一个接口文档目录，目录名默认是类名单词首字母小写多个单词以-隔开

        主要属性说明：

                tags        标签，接口文档模块的名称               

2、@ApiOperation()；

        作用于方法，生成接口文档，文档名默认与方法名相同

        主要属性说明：

                value        接口文档名称

3、@ApiParam();

        作用于参数，说明请求参数的作用，适用于单个请求参数的接口

        主要属性说明：

                name        参数名

                value        参数说明

                required        是否必须

4、@ApiImplicitParam()  、@ApiImplicitParams() ；

        ApiImplicitParam作用与方法，说明请求参数的作用，ApiImplicitParams可以包含多个ApiImplicitParam，用于多个参数说明

        示例：

@ApiImplicitParams({

                @ApiImplicitParam(name = "name",value = "姓名",required = true),                 @ApiImplicitParam(name = "age",value = "年龄",required = true)

})

@GetMapping("/sayHi")

public ResponseEntity<String> sayHi(String name, Integer age){

         return ResponseEntity.ok("Hi:"+name+age);

}

5、@ApiResponses、@ApiResponse 

        响应码说明

        主要属性说明：

                code        响应码

                message         说明

                response        抛异常的类

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