一、前言
springboot集成swagger,所有配置都配置好之后,访问:http://localhost:8081/swagger-ui/index.html#/
出现弹窗报错:
二、问题定位分析
1、 查看是否配置了拦截器,如果配置了,则放行swagger的相关请求
"/swagger-resources/**"
,"/webjars/**"
,"/v2/**"
,"/swagger-ui.html/**"
代码里未使用,此条排除
2、配置未加
看网上说的最多的就是在配置类上加 @EnableSwagger2 注解标签,一脸懵逼,都集成swagger了,不可能连这么基础的配置都不加的,所以不是这个问题,此条排除
3、项目中使用了全局统一处理类即@ControllerAdvice/ResponseBodyAdvice导致
项目中如果使用了@ControllerAdvice/ResponseBodyAdvice 全局处理接口返回值的类,会导致接口返回 JSON数据格式和 swagger 期望的不一样,造成 swagger 报错!
刚好有使用到这个!
三、解决方式
解决方法很简单,我们打开@ControllerAdvice注解类
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface ControllerAdvice {
@AliasFor("basePackages") // basePackages可限制扫描包的范围
String[] value() default {};
@AliasFor("value")
String[] basePackages() default {};
Class<?>[] basePackageClasses() default {};
Class<?>[] assignableTypes() default {};
Class<? extends Annotation>[] annotations() default {};
}
在代码上加上你自己扫描包的范围,因为@ControllerAdvice主要是封装controller层的,所以我们只让它扫描controller即可
修改完毕,重启服务,再次访问swagger,发现已经可以正常访问!
版权声明:本文为guocunlei25原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。