Swagger

Jump to bottom

luoml edited this page Aug 18, 2017 · 6 revisions

请求参数

@ApiImplicitParams
- 用在方法上，包含一组参数说明。
- 与@ApiParam的区别在于：对Servlets或者非JAX-RS的环境，只能使用 @ApiImplicitParam
@ApiImplicitParam
- 用在@ApiImplicitParams注解中，指定一个请求参数
- paramType：参数位置
  - header --> 请求参数的获取：@RequestHeader
  - query --> 请求参数的获取：@RequestParam
  - path --> 请求参数的获取：@PathVariable （用于restful接口）
  - body --> 请求参数的获取：@RequestBody
  - form --> 请求参数的获取：@FormParam
- name：参数名
- dataType：参数类型
- required：是否必传
- value：参数描述
- defaultValue：默认值

设置请求参数默认值

@ApiParam
- defaultValue="default value"
@ApiModelProperty
- example="default value"