Java-学习

Swagger:@ApiImplicitParams

2019-02-13  本文已影响0人  白云青叶

在开发过程中,我们会使用到swagger,其中有许多的注解,这里介绍一下注解@ApiImplicitParams 

注解功能:备注入参的中英文名称,配置必读、参数形式等,如下:

@ApiImplicitParams({

@ApiImplicitParam(value = "Id", name = "Id", required = true, dataType = "String", paramType = "query"),

@ApiImplicitParam(value = "名称", name = "name", required = true, dataType = "String", paramType = "query")

})

其中内部参数功能:
value :备注输入参数名称(中文)

name:备注输入参数名称(英文)

required :该入参是否必填

dataType:该入参的数据类型

paramType  :前台接口调用时url 参数形式

如:query 的形式:getUser?user =admin 

      path的形式:getUser/user/admin

上一篇 下一篇

猜你喜欢

热点阅读