解决swagger2.9.2接口文档显示的问题

swagger2.9.2接口文档显示

swagger版本:2.9.2

框架:springboot2.1.2

当没有使用

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

解决swagger2.9.2接口文档显示的问题_第1张图片

解决swagger2.9.2接口文档显示的问题_第2张图片

解决swagger2.9.2接口文档显示的问题_第3张图片

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

解决swagger2.9.2接口文档显示的问题_第4张图片

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

解决swagger2.9.2接口文档显示的问题_第5张图片

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

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

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

解决swagger2.9.2接口文档显示的问题_第6张图片

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

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

解决swagger2.9.2接口文档显示的问题_第7张图片

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

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

你可能感兴趣的