springfox swagger 请求参数类型设置
springfox swagger 请求参数类型设置
解析类：springfox.documentation.spring.web.readers.parameter.ParameterTypeReader
根据代码逻辑整理了一个表格
| 条件 | 对应parmType |
|---|---|
有@PathVariable注解 |
path |
有@RequestBody注解 |
body |
有@RequestPart注解 |
formData |
有@RequestHeader注解 |
header |
有@RequestParam注解 |
解析方式和无注解时一致 |
参数类型为MultipartFile或被Collection\Array等包装的MultipartFile |
form |
无任何注解consumes包含application/x-www-form-urlencoded且接口类型为post |
form |
无任何注解consumes包含multipart/form-data且接口类型为post |
formData |
| 无任何注解且不满足上述2个条件 | query |
| 不符合上述任何条件 | body |
到这里发现问题，我的接口参数很多都只有@ApiParam这一个注解来描述参数意义，这样就会都走到最后返回默认的body，导致接口发生问题，而正确的类型应该是query，由上表看来，使paramType变为query的方式有2种
- 不加任何注解、consumes不包含
application/x-www-form-urlencoded和multipart/form-data - 使用
@RequestParam注解，consumes不包含application/x-www-form-urlencoded和multipart/form-data
consumes我就没设置过，所以只能使用@RequestParam注解来使paramType变为query,但是每个接口都要加，这么大(xiao)的工作量我能妥协吗? 显然不能!
解决方案：
于是自定义CustomParameterTypeReader 修改默认的返回值为query，然后@Component、@Order作为bean并将优先级调至最低(@Order默认的就是最大值)，因为swagger插件的顺序是使用AnnotationAwareOrderComparator来排序的，这样，在原有的ParameterTypeReader配置paramType之后，我们自定义的CustomParameterTypeReader将覆盖paramType，实现最终目的
地址：https://www.leftso.com/article/1051.html
相关阅读
springfox swagger 请求参数类型设置解析类：springfox.documentation.spring.web.readers.parameter.ParameterTypeR...
swagger dataType 有那些2.6.x"int", "date", "string", "double", "float", "boolean", "byte", "object",...
Swagger Spring Boot Stater简介spring boot 整合 springfox 实现swagger api文档生成
1.前言通过前面的两篇博客Spring Boot Security Swagger2整合生成安全的在线REST API文档 SpringMVC也可参考spring boot REST 通过Swa...
【重要提示】：目前已有更好的方法，可以参考：Swagger2 导出离线 word文档一、使用背景 如今，REST和微服务已经有了很大的发展势头
Swagger2 导出离线文档简述继上一篇搬运国外的swagger2导出离线文档之后，最近发现国内一款不错的swagger ui组件和导出离线的方法，比之前的更简单优雅
创建REST API时，良好的文档是有帮助的。而且，API中的每一个变化都应该在参考文档中同时描述。手动完成这是一个乏味的操作，因此这个过程的自动化是不可避免的。
spring boot 项目启动报错
Failed to start bean 'documentationPluginsBootstrapper'; nested exception i...
我们知道spring boot可以通过文件名来区分配置，如下：application.ymlapplication-dev.yml #开发环境application-test.yml #测试环境...
1.注册中央仓库账号打开 https://issues.sonatype.org/ 注册一个账号。账号注册 填入你自己的账号注册信息即可。2.创建issues 登录成功后在导航找到新建点击弹窗...
热门文章
最新发布：