在平时工作中,写接口是最常见的,那么接口如何接收传进来的参数呢,今天跟大家分享一下Swagger中接口的一些常见注解用于接收参数,进行后续处理操作:
1. @Api :使用在类上,表明是swagger资源,@API拥有两个属性:value、tags
tags:说明该类的作用,可以在UI界面上看到的注解
value:无太大意义,可写接口地址
2. @ApiImplicitParam :作用在方法上,表示单独的请求参数
(参数:1.name:参数名,2. value:参数的具体意义、作用,3.required:参数是否必填,4.dataType:参数的数据类型,5.paramType:查询参数类型,有几种形式:path(以地址类型提交数据)、query(直接跟参数完成自动映射赋值)、body(以流的形式提交,仅支持post)、header(参数在request headers里边提交)、form(以form表单的形式提交,仅支持post))
3. @ApiImplicatParams:用于方法,包含多个@ApiImplicitParam,形式如下:
@ApiImplicatParams({
@ApiImplicitParam(),
@ApiImplicitParam(),
})
4. @ApiOperation:用于请求的方法上,说明方法的作用
values = “说明方法的作用”
notes=”方法的备注说明”
5. 当入参参数均为Json数据时,可用@RequestBody,直接接收对象(BO),而
当入参参数同时接收MultiPartFile和Json数据时,不能直接用@RequestBody,需要去掉@RequestBody,使用@RequestParam,文件使用@ApiParam:
以上就是接口中接收参数最常使用的几个注解,接下来的文章会跟大家详细介绍一下,一个接口如何开始写,如何能完成一个接口应有的功能