常用注解:
- @Api()用于类;
表示标识这个类是swagger的资源 - @ApiOperation()用于方法;
表示一个http请求的操作 - @ApiParam()用于方法,参数,字段说明;
表示对参数的添加元数据(说明或是否必填等)- name–参数名
- value–参数说明
- required–是否必填
- @ApiModel()用于类
表示对类进行说明,用于参数用实体类接收- value–表示对象名
- description–描述
- @ApiModelProperty()用于方法,字段
表示对model属性的说明或者数据操作更改- value–字段说明
- name–重写属性名字
- dataType–重写属性类型
- required–是否必填
- example–举例说明
- hidden–隐藏
- @ApiIgnore()用于类,方法,方法参数
表示这个方法或者类被忽略 - @ApiImplicitParam() 用于方法
表示单独的请求参数 - @ApiImplicitParams() 用于方法,包含多个 @ApiImplicitParam
- name–参数ming
- value–参数说明
- dataType–数据类型(默认类型是String,如果使用Integer可以设置为Int)
- paramType–参数类型
4.1 header-->请求参数的获取:@RequestHeader(代码中接收注解)
2.2 query-->请求参数的获取:@RequestParam(代码中接收注解)
4.3 path(用于restful接口)-->请求参数的获取:@PathVariable(代码中接收注解)
4.4 body-->请求参数的获取:@RequestBody(代码中接收注解)
4.5 form(不常用) - example–举例说明