Swagger:@ApiImplicitParams

在开发过程中,我们会使用到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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。
禁止转载,如需转载请通过简信或评论联系作者。

推荐阅读更多精彩内容