swagger常用注解

swagger常用注解

1、与模型相关的注解

     @ApiModel：用在模型类上，对模型类做注释；

     @ApiModelProperty：用在属性上，对属性做注释

2、与接口相关的注解

    @Api：用在controller上，对controller进行注释；

    @ApiOperation：用在API方法上，对该API做注释，说明API的作用；

    @ApiImplicitParams：用来包含API的一组参数注解，可以简单的理解为参数注解的集合声明；

    @ApiImplicitParam：用在@ApiImplicitParams注解中，也可以单独使用，说明一个请求参数的各个方面，该注解包含的常用选项有：

1.      paramType：参数所放置的地方，包含query、header、path、body以及form，最常用的是前四个。
2.      name：参数名；
3.      dataType：参数类型，可以是基础数据类型，也可以是一个class；
4.      required：参数是否必须传；
5.      value：参数的注释，说明参数的意义；
6.      defaultValue：参数的默认值；

    @ApiResponses：通常用来包含接口的一组响应注解，可以简单的理解为响应注解的集合声明；

    @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息

1.      code：即httpCode，例如400 
2.      message：信息，例如"请求参数没填好"