七叶笔记 » java编程 » 关于Swagger注释API的使用说明

关于Swagger注释API的使用说明

API详细说明

注释汇总

作用范围API使用位置对象属性@ApiModelProperty用在出入参数对象的字段上协议集描述@Api用于controller类上协议描述@ApiOperation用在controller的方法上Response集@ApiResponses用在controller的方法上Response@ApiResponse用在 @ApiResponses里边非对象参数集@ApiImplicitParams用在controller的方法上非对象参数描述@ApiImplicitParam用在@ApiImplicitParams的方法里边描述返回对象的意义@ApiModel用在返回对象类上

@RequestMapping此注解的推荐配置

valuemethodproduces

示例

@ApiImplicitParam 属性取值作用paramType 查询参数类型 path以地址的形式提交数据 query直接跟参数完成自动映射赋值 body以流的形式提交 仅支持POST header参数在request headers 里边提交 form以form表单的形式提交 仅支持POSTdataType 参数的数据类型 只作为标志说明,并没有实际验证 Long  String name 接收参数名value 接收参数的意义描述required 参数是否必填 true必填 false非必填defaultValue 默认值

paramType 示例详解

path

body

提交的参数是这个对象的一个json,然后会自动解析到对应的字段上去,也可以通过流的形式接收当前的请求数据,但是这个和上面的接收方式仅能使用一个(用@RequestBody之后流就会关闭了)    

接收对象传参的例子

在POJO上增加

注意: 在后台采用对象接收参数时,Swagger自带的工具采用的是JSON传参, 测试时需要在参数上加入@RequestBody,正常运行采用form或URL提交时候请删除。

header

Form

以上为个人经验,希望能给大家一个参考,也希望大家多多支持七叶笔记。

相关文章