Spring Swagger URL传参问题（转）

代码例子:

    @ApiOperation(value="获取用户详细信息", notes="根据url的id来获取用户详细信息")@ApiImplicitParam(paramType="path", name = "id", value = "用户ID", required = true, dataType = "Long")@RequestMapping(value="/{id}", method=RequestMethod.GET)public User getUser(@PathVariable Long id) {return users.get(id);}

网上好多例子都没有paramType这个参数，导致获取不到URL的参数，特意记录一下

详细的注解说明

@Api：用在类上，说明该类的作用
@ApiOperation：用在方法上，说明方法的作用
@ApiImplicitParams：用在方法上包含一组参数说明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
- paramType：参数放在哪个地方
  - header-->请求参数的获取：@RequestHeader
  - query-->请求参数的获取：@RequestParam
  - path（用于restful接口）-->请求参数的获取：@PathVariable
  - body（不常用）
  - form（不常用）
- name：参数名
- dataType：参数类型
- required：参数是否必须传
- value：参数的意思
- defaultValue：参数的默认值
@ApiResponses：用于表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
- code：数字，例如400
- message：信息，例如"请求参数没填好"
- response：抛出异常的类
@ApiModel：描述一个Model的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）
- @ApiModelProperty：描述一个model的属性

感谢赵计刚大大的博文分享，终于解决这问题

参考链接：http://www.cnblogs.com/java-zhao/p/5348113.html

官方文档解说：https://github.com/OAI/OpenAPI-Specification/blob/master/versions/1.2.md#524-parameter-object

转载地址:https://my.oschina.net/lyaohe/blog/1503254

转载于:https://www.cnblogs.com/alsodzy/p/9290836.html

Spring Swagger URL传参问题（转）相关推荐

Java URL传参中文乱码问题
2019独角兽企业重金招聘Python工程师标准>>> 我们经常会遇到这样的场景:在URL中传递参数,如果该参数为中文,如果设置不当,会出现乱码问题. URL传参所使用的编码为服务器 ...
python get请求 url传参_requests的get请求url参数、url重定向处理及cookies
需求:在百度搜索www.python66.com,然后将搜索结果保存到文件bd_python66.html 百度搜索的url:https://www.baidu.com/s?wd=搜索词 params ...
关于url传参中文乱码问题
之前都一直很不了解中文编码得问题,之前在做项目中没碰到那么头痛的问题.所以一直没有了解中文乱码的问题. 问题描述: 地址: http://localhost:8080/sun-government/c ...
微信小程序页面跳转，url传参参数丢失问题
微信小程序页面跳转,url传参参数丢失问题 // pages/order/purchase/index.js// 跳转到采购订单详情toPurchaseOrderDetail(e) {// conso ...
记一次vue踩坑 this.$router.back()在ios失效,试了各种返回，最后发现是因为url传参的原因，去掉参数就可以了。。
因为之前有项目也用过类型的,我就找不同,发现之前项目的打包完直接用的....index.html访问现在的项目用的....index.html#/访问的 --------------------- ...
URL传参时从URL中获取中文参数的方法
利用url传参时如果url中的参数是中文时因为编码类型不同在页面中获取会出现乱码使用此方法能获取url中的参数值并解决乱码问题调用时直接 GetUrlByParamName("参数名& ...
vue前后端aes url传参解密再解base64编码
需求:我们公司做机票订购服务,有自己的平台的订单,也有第三方网站向我们网站导入的用户订单,第三方导入的是通过url传参的方式导入.url会携带用户的相关信息. url里面的参数是经过aes加密和bas ...
url 传参时包含或者#号时当成参数解析的问题
url 传参时包含&或者#号时当成参数解析的问题当url地址传递参数时,值中一个含有&符号时可能会出现解析错误的情况,最好的解决办法就是将&符号进行replace成其他格式字 ...
html页面url中文传值乱码,URL传参时，中文参数乱码的解决方法
URL传参时,中文参数乱码的解决: 今天在工作中遇到了这样的一个问题,在页面之间跳转时,我将中文的参数放入到url中,使用location进行跳转传参,但是发现接收到的参数值是乱码.我的代码是这样写的 ...

Spring Swagger URL传参问题（转）

Spring Swagger URL传参问题（转）相关推荐

最新文章

热门文章