如何解决swagger2.9.2接口文档显示的各种问题

这篇文章主要讲解了“如何解决swagger2.9.2接口文档显示的各种问题”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“如何解决swagger2.9.2接口文档显示的各种问题”吧!

swagger2.9.2接口文档显示

swagger版本:2.9.2

框架:springboot2.1.2

当没有使用

@ApiImplicitParam和response=Resp.class时,swagger会自动去显示接口入参对象的各属性,及响应的对象属性,如下图:

如何解决swagger2.9.2接口文档显示的各种问题

如何解决swagger2.9.2接口文档显示的各种问题

如何解决swagger2.9.2接口文档显示的各种问题

而如果加入@ApiImplicitParam和response=Resp.class时,则没有任务字段属性显示,如下:

如何解决swagger2.9.2接口文档显示的各种问题

所以建议,当接口的入参为几个字段属性时可以加上@ApiImplicitParam进行描述,如果是对象,则只要在该 VO对象用@ApiModel和@ApiModelProperty进行注解后,在接口方法上就不需要加@ApiImplicitParam了,swagger会自动进行解析。

如何解决swagger2.9.2接口文档显示的各种问题

Spring Boot整合swagger2.9.2版本出现的小问题

访问接口文档地址时,单个应用能正常访问swagger-ui.html页面

但F12看到请求接口有报错:

如何解决swagger2.9.2接口文档显示的各种问题

但因为在gateway网关进行了各个服务的接口文档聚合,所以在gateway访问时一直报错,因此最后只能降版本,讲到Swagger2.8.0版本。

然后请求时相比2.9.2版本少了两个请求:

如何解决swagger2.9.2接口文档显示的各种问题

这算是2.9.x版本的一个小问题吧,可以看github提交的问题

感谢各位的阅读,以上就是“如何解决swagger2.9.2接口文档显示的各种问题”的内容了,经过本文的学习后,相信大家对如何解决swagger2.9.2接口文档显示的各种问题这一问题有了更深刻的体会,具体使用情况还需要大家实践验证。这里是亿速云,小编将为大家推送更多相关知识点的文章,欢迎关注!