SpringBoot整合Swagger3.0使用及报错解决大全
创始人
2024-06-03 08:09:01
0

前言

Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。

在这里插入图片描述

StepDescription
1引入Maven依赖
2在Spring Boot中启用Swagger
3创建SwaggerConfig类
4创建Docket Bean
5提供API信息
6配置Swagger UI
7应用Swagger

项目背景

在这里插入图片描述

版本

SpringBoot 2.7.*
springfox 3.0

Maven依赖


io.springfoxspringfox-swagger23.0.0


io.springfoxspringfox-boot-starter3.0.0

@Configuration
@EnableSwagger2
@EnableAutoConfiguration
@ConditionalOnProperty(name = "swagger.enabled", matchIfMissing = true)
public class SwaggerAutoConfiguration
{/*** 默认的排除路径,排除Spring Boot默认的错误处理路径和端点*/private static final List DEFAULT_EXCLUDE_PATH = Arrays.asList("/error", "/actuator/**");private static final String BASE_PATH = "/**";@Bean@ConditionalOnMissingBeanpublic SwaggerProperties swaggerProperties(){return new SwaggerProperties();}@Beanpublic Docket api(SwaggerProperties swaggerProperties){// base-path处理if (swaggerProperties.getBasePath().isEmpty()){swaggerProperties.getBasePath().add(BASE_PATH);}// noinspection uncheckedList> basePath = new ArrayList>();swaggerProperties.getBasePath().forEach(path -> basePath.add(PathSelectors.ant(path)));// exclude-path处理if (swaggerProperties.getExcludePath().isEmpty()){swaggerProperties.getExcludePath().addAll(DEFAULT_EXCLUDE_PATH);}List> excludePath = new ArrayList<>();swaggerProperties.getExcludePath().forEach(path -> excludePath.add(PathSelectors.ant(path)));ApiSelectorBuilder builder = new Docket(DocumentationType.SWAGGER_2).host(swaggerProperties.getHost()).apiInfo(apiInfo(swaggerProperties)).select().apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackage()));swaggerProperties.getBasePath().forEach(p -> builder.paths(PathSelectors.ant(p)));swaggerProperties.getExcludePath().forEach(p -> builder.paths(PathSelectors.ant(p).negate()));return builder.build().securitySchemes(securitySchemes()).securityContexts(securityContexts()).pathMapping("/");}/*** 安全模式,这里指定token通过Authorization头请求头传递*/private List securitySchemes(){List apiKeyList = new ArrayList();apiKeyList.add(new ApiKey("Authorization", "Authorization", "header"));return apiKeyList;}/*** 安全上下文*/private List securityContexts(){List securityContexts = new ArrayList<>();securityContexts.add(SecurityContext.builder().securityReferences(defaultAuth()).operationSelector(o -> o.requestMappingPattern().matches("/.*")).build());return securityContexts;}/*** 默认的全局鉴权策略** @return*/private List defaultAuth(){AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];authorizationScopes[0] = authorizationScope;List securityReferences = new ArrayList<>();securityReferences.add(new SecurityReference("Authorization", authorizationScopes));return securityReferences;}private ApiInfo apiInfo(SwaggerProperties swaggerProperties){return new ApiInfoBuilder().title(swaggerProperties.getTitle()).description(swaggerProperties.getDescription()).license(swaggerProperties.getLicense()).licenseUrl(swaggerProperties.getLicenseUrl()).termsOfServiceUrl(swaggerProperties.getTermsOfServiceUrl()).contact(new Contact(swaggerProperties.getContact().getName(), swaggerProperties.getContact().getUrl(), swaggerProperties.getContact().getEmail())).version(swaggerProperties.getVersion()).build();}
}
@Component
@ConfigurationProperties("swagger")
public class SwaggerProperties
{/*** 是否开启swagger*/private Boolean enabled;/*** swagger会解析的包路径**/private String basePackage = "";/*** swagger会解析的url规则**/private List basePath = new ArrayList<>();/*** 在basePath基础上需要排除的url规则**/private List excludePath = new ArrayList<>();/*** 标题**/private String title = "";/*** 描述**/private String description = "";/*** 版本**/private String version = "";/*** 许可证**/private String license = "";/*** 许可证URL**/private String licenseUrl = "";/*** 服务条款URL**/private String termsOfServiceUrl = "";/*** host信息**/private String host = "";/*** 联系人信息*/private Contact contact = new Contact();/*** 全局统一鉴权配置**/private Authorization authorization = new Authorization();public Boolean getEnabled(){return enabled;}public void setEnabled(Boolean enabled){this.enabled = enabled;}public String getBasePackage(){return basePackage;}public void setBasePackage(String basePackage){this.basePackage = basePackage;}public List getBasePath(){return basePath;}public void setBasePath(List basePath){this.basePath = basePath;}public List getExcludePath(){return excludePath;}public void setExcludePath(List excludePath){this.excludePath = excludePath;}public String getTitle(){return title;}public void setTitle(String title){this.title = title;}public String getDescription(){return description;}public void setDescription(String description){this.description = description;}public String getVersion(){return version;}public void setVersion(String version){this.version = version;}public String getLicense(){return license;}public void setLicense(String license){this.license = license;}public String getLicenseUrl(){return licenseUrl;}public void setLicenseUrl(String licenseUrl){this.licenseUrl = licenseUrl;}public String getTermsOfServiceUrl(){return termsOfServiceUrl;}public void setTermsOfServiceUrl(String termsOfServiceUrl){this.termsOfServiceUrl = termsOfServiceUrl;}public String getHost(){return host;}public void setHost(String host){this.host = host;}public Contact getContact(){return contact;}public void setContact(Contact contact){this.contact = contact;}public Authorization getAuthorization(){return authorization;}public void setAuthorization(Authorization authorization){this.authorization = authorization;}public static class Contact{/*** 联系人**/private String name = "";/*** 联系人url**/private String url = "";/*** 联系人email**/private String email = "";public String getName(){return name;}public void setName(String name){this.name = name;}public String getUrl(){return url;}public void setUrl(String url){this.url = url;}public String getEmail(){return email;}public void setEmail(String email){this.email = email;}}public static class Authorization{/*** 鉴权策略ID,需要和SecurityReferences ID保持一致*/private String name = "";/*** 需要开启鉴权URL的正则*/private String authRegex = "^.*$";/*** 鉴权作用域列表*/private List authorizationScopeList = new ArrayList<>();private List tokenUrlList = new ArrayList<>();public String getName(){return name;}public void setName(String name){this.name = name;}public String getAuthRegex(){return authRegex;}public void setAuthRegex(String authRegex){this.authRegex = authRegex;}public List getAuthorizationScopeList(){return authorizationScopeList;}public void setAuthorizationScopeList(List authorizationScopeList){this.authorizationScopeList = authorizationScopeList;}public List getTokenUrlList(){return tokenUrlList;}public void setTokenUrlList(List tokenUrlList){this.tokenUrlList = tokenUrlList;}}public static class AuthorizationScope{/*** 作用域名称*/private String scope = "";/*** 作用域描述*/private String description = "";public String getScope(){return scope;}public void setScope(String scope){this.scope = scope;}public String getDescription(){return description;}public void setDescription(String description){this.description = description;}}
/*** swagger 资源映射路径* */
@Configuration
public class SwaggerWebConfiguration implements WebMvcConfigurer
{@Overridepublic void addResourceHandlers(ResourceHandlerRegistry registry){/** swagger-ui 地址 */registry.addResourceHandler("/swagger-ui/**").addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/");}
}

报错一:: Failed to start bean ‘documentationPluginsBootstrapper’; nested exception is java.lang.NullPointerException

org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerExceptionat org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:181)at org.springframework.context.support.DefaultLifecycleProcessor.access$200(DefaultLifecycleProcessor.java:54)at org.springframework.context.support.DefaultLifecycleProcessor$LifecycleGroup.start(DefaultLifecycleProcessor.java:356)at java.lang.Iterable.forEach(Iterable.java:75)at org.springframework.context.support.DefaultLifecycleProcessor.startBeans(DefaultLifecycleProcessor.java:155)at org.springframework.context.support.DefaultLifecycleProcessor.onRefresh(DefaultLifecycleProcessor.java:123)at org.springframework.context.support.AbstractApplicationContext.finishRefresh(AbstractApplicationContext.java:935)at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:586)at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:147)at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:734)at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:408)at org.springframework.boot.SpringApplication.run(SpringApplication.java:308)at org.springframework.boot.SpringApplication.run(SpringApplication.java:1306)at org.springframework.boot.SpringApplication.run(SpringApplication.java:1295)at *Application.main(Application.java:22)at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)at java.lang.reflect.Method.invoke(Method.java:498)at org.springframework.boot.devtools.restart.RestartLauncher.run(RestartLauncher.java:49)
Caused by: java.lang.NullPointerException: nullat springfox.documentation.spring.web.WebMvcPatternsRequestConditionWrapper.getPatterns(WebMvcPatternsRequestConditionWrapper.java:56)at springfox.documentation.RequestHandler.sortedPaths(RequestHandler.java:113)at springfox.documentation.spi.service.contexts.Orderings.lambda$byPatternsCondition$3(Orderings.java:89)at java.util.Comparator.lambda$comparing$77a9974f$1(Comparator.java:469)at java.util.TimSort.countRunAndMakeAscending(TimSort.java:355)at java.util.TimSort.sort(TimSort.java:234)at java.util.Arrays.sort(Arrays.java:1512)at java.util.ArrayList.sort(ArrayList.java:1454)at java.util.stream.SortedOps$RefSortingSink.end(SortedOps.java:387)at java.util.stream.Sink$ChainedReference.end(Sink.java:258)at java.util.stream.Sink$ChainedReference.end(Sink.java:258)at java.util.stream.Sink$ChainedReference.end(Sink.java:258)at java.util.stream.Sink$ChainedReference.end(Sink.java:258)at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:482)at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:471)at java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:708)at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234)at java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:499)at springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider.requestHandlers(WebMvcRequestHandlerProvider.java:81)at java.util.stream.ReferencePipeline$3$1.accept(ReferencePipeline.java:193)at java.util.ArrayList$ArrayListSpliterator.forEachRemaining(ArrayList.java:1374)at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:481)at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:471)at java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:708)at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234)at java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:499)at springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper.withDefaults(AbstractDocumentationPluginsBootstrapper.java:107)at springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper.buildContext(AbstractDocumentationPluginsBootstrapper.java:91)at springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper.bootstrapDocumentationPlugins(AbstractDocumentationPluginsBootstrapper.java:82)at springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper.start(DocumentationPluginsBootstrapper.java:100)at org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:178)... 19 common frames omitted

从报错顺序跟踪源码查看执行步骤

step操作
1SpringBoot 启动同时Bean初始化完毕
2初始化DocumentationPluginsBootstrapper同时将RequestHandlerProvider通过构造器驻入
3调用DocumentationPluginsBootstrapper start 方法加载Docket插件
4解析RequestHandlerProvider并将数据存到DocumentationCache中
5请求Swagger2Controller 的v2/api-docs接口,通过groupName从DocumentationCache中将数据取出,在将数据统一封装到Swagger类中,序列化成json返回给

报错二:No operations defined in spec!

在这里插入图片描述

解决

SpringBoot 2.6.0开始,请求路径与SpringMVC处理映射匹配的默认策略已从AntPathMatcher更改为PathPatternParser。可以通过设置spring.mvc.pathmatch.matching-strategy为ant-path-matcher来改变。

除了basePackage包路径配错以外。以下方案可解决以上问题。

/*** swagger 在 springboot 2.6.x 不兼容问题的处理**/
@Component
public class SwaggerBeanPostProcessor implements BeanPostProcessor
{@Overridepublic Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException{if (bean instanceof WebMvcRequestHandlerProvider || bean instanceof WebFluxRequestHandlerProvider){customizeSpringfoxHandlerMappings(getHandlerMappings(bean));}return bean;}private  void customizeSpringfoxHandlerMappings(List mappings){List copy = mappings.stream().filter(mapping -> mapping.getPatternParser() == null).collect(Collectors.toList());mappings.clear();mappings.addAll(copy);}@SuppressWarnings("unchecked")private List getHandlerMappings(Object bean){try{Field field = ReflectionUtils.findField(bean.getClass(), "handlerMappings");field.setAccessible(true);return (List) field.get(bean);}catch (IllegalArgumentException | IllegalAccessException e){throw new IllegalStateException(e);}}
}

配置:

spring:mvc:pathmatch:matching-strategy: ant_path_matcher

在这里插入图片描述

心如欲壑,后土难填。

相关内容

热门资讯

安卓系统怎样拍视频,安卓系统视... 亲爱的手机摄影爱好者们,你是否曾想过,你的安卓手机竟然可以拍出专业级别的视频?没错,就是那个你每天不...
飞利浦电视安卓系统卡,飞利浦电... 你有没有遇到过这种情况?家里的飞利浦电视用着用着,突然间安卓系统就卡住了,屏幕上那些花花绿绿的图标都...
收银系统源码安卓手机,功能模块... 你有没有想过,那些在超市、便利店、餐厅里忙碌的收银员,他们手中的收银系统,其实背后有着一套复杂的源码...
安卓系统那种手机最好,盘点性能... 你有没有想过,安卓系统那种手机最好呢?在这个科技飞速发展的时代,手机已经成为了我们生活中不可或缺的一...
怎么视频截图安卓系统,安卓系统... 亲爱的手机控们,你是不是也和我一样,有时候在手机上看视频时,突然发现了一个特别有趣的瞬间,想要截图保...
vivo系统基于安卓吗,基于安... 你有没有想过,你的vivo手机里那个流畅又好用的系统,其实是在安卓的大树下茁壮成长的呢?没错,viv...
魅族降系统安卓13系统,探索无... 你知道吗?最近手机圈里可是炸开了锅,魅族这个品牌竟然悄悄地给自家手机升级了安卓13系统!这可真是让人...
安卓手机查看系统信息,系统信息... 你有没有想过,你的安卓手机里藏着多少秘密?别小看那小小的屏幕,它可是个信息宝库呢!今天,就让我带你一...
安卓7.0系统相机崩溃,原因分... 最近是不是你也遇到了安卓7.0系统相机崩溃的烦恼?别急,让我来给你详细说说这个让人头疼的问题,让你一...
安卓u子系统系统u盘,Andr... 你有没有想过,你的安卓手机里有一个神秘的“U子系统”,它就像一个隐藏的宝藏,等待着你去探索。今天,就...
联想怎么下载安卓系统,安卓系统... 你有没有想过,你的联想手机或者平板,有一天也能装上安卓系统的全新面貌呢?没错,今天就要来手把手教你如...
查老式安卓系统版本,展望未来 你有没有发现,手机里的安卓系统版本有时候就像是个神秘的宝藏,藏着许多不为人知的秘密呢?今天,就让我带...
核酸录入安卓机系统,基于安卓系... 你有没有想过,那些看似简单的核酸检测,背后竟然有这么复杂的“大脑”——安卓机系统?没错,就是那个我们...
高邮苹果刷安卓系统,安卓系统助... 你有没有想过,那些我们平时吃的苹果,竟然也能刷上安卓系统?听起来是不是有点不可思议?没错,今天就要带...
安卓系统的ar眼镜,安卓系统赋... 你有没有想过,未来科技的世界里,眼镜不仅仅是用来看清世界的工具,还能成为你的得力助手?没错,说的就是...
怎样删安卓系统垃圾,揭秘安卓系... 手机里的安卓系统是不是越来越卡了?是不是觉得那些垃圾文件占据了太多空间,让你头疼不已?别急,今天就来...
畅享10安卓系统,畅享智能生活... 你有没有听说啊?最近安卓系统又来了一次大升级,这次可是直接跳到了10版本,听起来是不是很酷炫?没错,...
安卓怎么刷荣耀系统,轻松刷入荣... 你有没有想过,你的安卓手机能不能来点不一样的风采呢?没错,就是刷机!今天,就让我来带你一起探索如何给...
安卓系统游戏占用内存,揭秘内存... 手机里的游戏是不是越来越多了?每次打开,那内存占用简直让人头疼!今天,就让我来和你聊聊安卓系统游戏占...
安卓驱动系统开发,基于安卓驱动... 你有没有想过,你的安卓手机里那些神奇的驱动系统是怎么来的?没错,就是那些让手机能够顺畅运行各种应用的...