Swagger注解

Swagger的注释
1：通过在控制器类上增加@Api 注解，可以给控制器增加描述和标签信息，用在类上，说明该类的作用，例如：

@Api(tags = "tailwind_Admin",description = "顺风服务管理接口")
class AdminControllerTailwindDemand{

@Api 主要属性

注解属性	类型	描述
tags	String[]	控制器标签
description	String	控制器描述（该字段被申明为过期）

2：@ApiOperation: 用在方法上，说明方法的作用，可设置对接口的描述，例如：

 @ApiOperation(value = "新增顺风服务" ,notes = "tailwindDemand:需求数据")
 public R insertDemand(TailwindDemand tailwindDemand
            ,@RequestParam(value = "carfile",required = false)MultipartFile carfile
            ,@RequestParam(value = "drivingLicencefile",required = false)MultipartFile drivingLicencefile
            ,@RequestParam(value = "drivingLicensefile",required = false)MultipartFile drivingLicensefile) throws Exception {

@ApiOperation 主要属性

注解属性	类型	描述
value	String	接口说明
notes	String	接口发布说明
tags	Stirng[]	标签
response	Class<?>	接口返回类型
httpMethod	String	接口请求方式

3:@ApiImplicitParams: 用于描述接口的非对象参数集,例如：

@ApiImplicitParams(value = {
            @ApiImplicitParam(name = "carfile",value = "车辆照片",dataType = "file",paramType = "formData"),
            @ApiImplicitParam(name = "drivingLicencefile",value = "驾驶证照片",dataType = "file",paramType = "formData"),
            @ApiImplicitParam(name = "drivingLicensefile",value = "行驶证图片",dataType = "file",paramType = "formData")})
    public R insertDemand(TailwindDemand tailwindDemand
            ,@RequestParam(value = "carfile",required = false)MultipartFile carfile
            ,@RequestParam(value = "drivingLicencefile",required = false)MultipartFile drivingLicencefile
            ,@RequestParam(value = "drivingLicensefile",required = false)MultipartFile drivingLicensefile) throws Exception {

4：@ApiImplicitParam: 用于描述接口的非对象参数，一般与 @ApiImplicitParams 组合使用，例如

@ApiImplicitParams(value = {
            @ApiImplicitParam(name = "carfile",value = "车辆照片",dataType = "file",paramType = "formData"),
            @ApiImplicitParam(name = "drivingLicencefile",value = "驾驶证照片",dataType = "file",paramType = "formData"),
            @ApiImplicitParam(name = "drivingLicensefile",value = "行驶证图片",dataType = "file",paramType = "formData")})
    public R insertDemand(TailwindDemand tailwindDemand
            ,@RequestParam(value = "carfile",required = false)MultipartFile carfile
            ,@RequestParam(value = "drivingLicencefile",required = false)MultipartFile drivingLicencefile
            ,@RequestParam(value = "drivingLicensefile",required = false)MultipartFile drivingLicensefile) throws Exception {

@ApiImplicitParam 主要属性

注解属性	描述
paramType	查询参数类型，实际上就是参数放在那里
dataType	参数的数据类型
name	参数名字
value	参数意义的描述
required	是否必填

5：@ApiModel: 可设置接口相关实体的描述

@ApiModel(value="tailwind_顺风服务表", description="tailwind_demand")
public class TailwindDemand implements Serializable {

6：@ApiModelProperty: 可设置实体属性的相关描述。

@ApiModelProperty(value = "用户id")
private Long userId;