Swagger常用注解

• @Api 修饰整个类，描述Controller的作用。
• @ApiOperation 修饰一个类的一个方法，或者说一个接口 ，可以描述这个方法的功能和注意事项。若不使用则用函数名作为方法功能。参数：value=“说明方法的用途、作用”，notes=“方法的备注说明”
• @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面。name：参数名，value：参数的汉字说明、解释，required：参数是否必须传，paramType：参数放在哪个地方（header --> 请求参数的获取：@RequestHeader，query --> 请求参数的获取：@RequestParam，path（用于restful接口）–> 请求参数的获取：@PathVariable，body（不常用），form（不常用）)，dataType：参数类型，默认String，其它值dataType=“Integer”，defaultValue：参数的默认值
• @apiResponses：用在请求的方法上，表示一组响应
• @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息。
• @ApiImplicitParams 修饰方法，可以描述这个方法的参数的作用。若不使用则用参数名作为参数的作用。
• @ApiModel 修饰实体类，可以描述这个类的功能。
• @ApiModelProperty 修饰实体类的属性，可以描述这个属性的作用。
• @ApiIgnore修饰参数、方法和类，可以在自动生成文档时对修饰的对象进行忽略。
• @ApiError ：发生错误返回的信息