@ApiImplicitParam 中swagger的使用

@ApiResponses、@ApiResponse、@ApiImplicitParams、ApiImplicitParam

原创博客:https://blog.csdn.net/qq_36826506/article/details/82182817

@ApiImplicitParam:
作用在方法上,表示单独的请求参数 
参数: 
1. name :参数名。 
2. value : 参数的具体意义,作用。 
3. required : 参数是否必填。 
4. dataType :参数的数据类型。 
5. paramType :查询参数类型,这里有几种形式:

类型    作用
path    以地址的形式提交数据
query    直接跟参数完成自动映射赋值
body    以流的形式提交 仅支持POST
header    参数在request headers 里边提交
form    以form表单的形式提交 仅支持POST

在这里我被坑过一次:当我发POST请求的时候,当时接受的整个参数,不论我用body还是query,后台都会报Body Missing错误。这个参数和SpringMvc中的@RequestBody冲突,索性我就去掉了paramType,对接口测试并没有影响。

@ApiImplicitParams:
用于方法,包含多个 @ApiImplicitParam: 
例:

  @ApiOperation("查询测试")
  @GetMapping("select")
  //@ApiImplicitParam(name="name",value="用户名",dataType="String", paramType = "query")
  @ApiImplicitParams({
  @ApiImplicitParam(name="name",value="用户名",dataType="string", paramType = "query",example="xingguo"),
  @ApiImplicitParam(name="id",value="用户id",dataType="long", paramType = "query")})
  public void select(){

  }

@ApiImplicitParam 中swagger的使用_第1张图片

效果图: 
--------------------- 
作者:云皓 
来源:CSDN 
原文:https://blog.csdn.net/qq_36826506/article/details/82182817 
版权声明:本文为博主原创文章,转载请附上博文链接!

你可能感兴趣的:(java)