参考了SpringBoot 整合 Swagger_responsestandard=false-CSDN博客
SpringBoot 整合 Swagger_responsestandard=false-CSDN博客
解决方法
一、maven依赖
<!-- swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.9</version>
</dependency>
二、SwaggerConfig.java
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
import java.util.List;
/**
* @author DW
* 2024/01/07
*/
@EnableSwagger2
@Configuration
public class SwaggerConfig {
private static final String headerKey = "token"; //header参数的key
@Bean
public Docket createRestApi() {
// 添加header参数headerKey
ParameterBuilder parameterBuilder = new ParameterBuilder();
List<Parameter> parameterList = new ArrayList<>();
parameterBuilder.name(headerKey).description(headerKey)
.modelRef(new ModelRef("string")).parameterType("header")
.required(false).build();
parameterList.add(parameterBuilder.build());
return new Docket(DocumentationType.SWAGGER_2)
.pathMapping("/")
.select()
.apis(RequestHandlerSelectors.basePackage("com.andon.springbootutil.controller")) //注意这里调用你的控制类
.paths(PathSelectors.any())
.build()
.globalOperationParameters(parameterList)
.apiInfo(new ApiInfoBuilder()
.title("spring-boot-util")
.description("")
.version("v1.0")
.contact(new Contact("", "", ""))
.license("")
.licenseUrl("")
.build());
}
}
三、配置WebMvcConfigurer.java
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
/**
* @author DW
* 2024/01/07
*/
@Configuration
public class WebMvcConfigurer extends WebMvcConfigurationSupport {
/**
* 发现如果继承了WebMvcConfigurationSupport,则在yml中配置的相关内容会失效。 需要重新指定静态资源
*/
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/**").addResourceLocations(
"classpath:/static/");
registry.addResourceHandler("swagger-ui.html", "doc.html").addResourceLocations(
"classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations(
"classpath:/META-INF/resources/webjars/");
super.addResourceHandlers(registry);
}
}
四、配置文件添加spring.mvc.pathmatch.matching-strategy=ant_path_matcher
spring:
mvc:
pathmatch:
matching-strategy: ant_path_matcher
解决完成
启动项目(最好重启ide)打开swagger
http://localhost:8080/swagger-ui.html#/
其他
注意事项
两个文件位置
不生效就关闭ide重启一下。
后面遇到配置的静态资源访问不了,修改了WebMvcConfigurer.java
package com.example.config;
/**
* Description:
* Param:
* Return:
* Author: DW
* Date: 2024/1/7
*/
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
@Configuration
public class WebMvcConfigurer extends WebMvcConfigurationSupport {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html", "doc.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
registry.addResourceHandler("/image/**") // 为自定义路径添加资源处理器
.addResourceLocations("file:./static/image/"); // 添加自定义资源路径
super.addResourceHandlers(registry);
}
}
原报错日志
16:40:16,606 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Could NOT find resource [logback-test.xml]
16:40:16,607 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Found resource [logback.xml] at [file:/K:/Study/Java/week14_%e5%ad%a6%e4%b9%a0%e8%b5%84%e6%96%99/%e6%a1%88%e4%be%8b/springboot_14/target/classes/logback.xml]
16:40:16,660 |-INFO in ch.qos.logback.classic.joran.action.ConfigurationAction - debug attribute not set
16:40:16,662 |-INFO in ch.qos.logback.core.joran.action.AppenderAction - About to instantiate appender of type [ch.qos.logback.core.ConsoleAppender]
16:40:16,667 |-INFO in ch.qos.logback.core.joran.action.AppenderAction - Naming appender as [console]
16:40:16,701 |-INFO in ch.qos.logback.core.joran.action.AppenderAction - About to instantiate appender of type [ch.qos.logback.core.rolling.RollingFileAppender]
16:40:16,703 |-INFO in ch.qos.logback.core.joran.action.AppenderAction - Naming appender as [timeFileOutput]
16:40:16,711 |-INFO in c.q.l.core.rolling.TimeBasedRollingPolicy@327177752 - Will use gz compression
16:40:16,712 |-INFO in c.q.l.core.rolling.TimeBasedRollingPolicy@327177752 - Will use the pattern ./logTest/info.%d{yyyy-MM-dd}.%i.log for the active file
16:40:16,714 |-INFO in ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP@56ef9176 - The date pattern is 'yyyy-MM-dd' from file name pattern './logTest/info.%d{yyyy-MM-dd}.%i.log.gz'.
16:40:16,714 |-INFO in ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP@56ef9176 - Roll-over at midnight.
16:40:16,714 |-INFO in ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP@56ef9176 - Setting initial period to Sun Jan 07 16:38:54 CST 2024
16:40:16,714 |-WARN in ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP@56ef9176 - SizeAndTimeBasedFNATP is deprecated. Use SizeAndTimeBasedRollingPolicy instead
16:40:16,714 |-WARN in ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP@56ef9176 - For more information see http://logback.qos.ch/manual/appenders.html#SizeAndTimeBasedRollingPolicy
16:40:16,718 |-INFO in ch.qos.logback.core.rolling.RollingFileAppender[timeFileOutput] - Active log file name: ./logTest/test.log
16:40:16,718 |-INFO in ch.qos.logback.core.rolling.RollingFileAppender[timeFileOutput] - File property is set to [./logTest/test.log]
16:40:16,720 |-INFO in ch.qos.logback.classic.joran.action.RootLoggerAction - Setting level of ROOT logger to INFO
16:40:16,720 |-INFO in ch.qos.logback.core.joran.action.AppenderRefAction - Attaching appender named [console] to Logger[ROOT]
16:40:16,720 |-INFO in ch.qos.logback.core.joran.action.AppenderRefAction - Attaching appender named [timeFileOutput] to Logger[ROOT]
16:40:16,720 |-INFO in ch.qos.logback.classic.joran.action.ConfigurationAction - End of configuration.
16:40:16,721 |-INFO in ch.qos.logback.classic.joran.JoranConfigurator@4566e5bd - Registering current configuration as safe fallback point
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.7.5)
2024-01-07 16:40:17.128 [main] INFO com.example.DemoApplication - Starting DemoApplication using Java 1.8.0_202 on DESKTOP-TOF5L2H with PID 41424 (K:\Study\Java\week14_学习资料\案例\springboot_14\target\classes started by 18032 in K:\Study\Java\week14_学习资料\案例\springboot_14)
2024-01-07 16:40:17.130 [main] INFO com.example.DemoApplication - No active profile set, falling back to 1 default profile: "default"
2024-01-07 16:40:17.926 [main] INFO o.s.d.r.config.RepositoryConfigurationDelegate - Bootstrapping Spring Data JPA repositories in DEFAULT mode.
2024-01-07 16:40:17.992 [main] INFO o.s.d.r.config.RepositoryConfigurationDelegate - Finished Spring Data repository scanning in 55 ms. Found 4 JPA repository interfaces.
2024-01-07 16:40:18.435 [main] INFO o.s.boot.web.embedded.tomcat.TomcatWebServer - Tomcat initialized with port(s): 8080 (http)
2024-01-07 16:40:18.443 [main] INFO org.apache.coyote.http11.Http11NioProtocol - Initializing ProtocolHandler ["http-nio-8080"]
2024-01-07 16:40:18.444 [main] INFO org.apache.catalina.core.StandardService - Starting service [Tomcat]
2024-01-07 16:40:18.444 [main] INFO org.apache.catalina.core.StandardEngine - Starting Servlet engine: [Apache Tomcat/9.0.68]
2024-01-07 16:40:18.651 [main] INFO o.a.c.core.ContainerBase.[Tomcat].[localhost].[/] - Initializing Spring embedded WebApplicationContext
2024-01-07 16:40:18.651 [main] INFO o.s.b.w.s.c.ServletWebServerApplicationContext - Root WebApplicationContext: initialization completed in 1487 ms
2024-01-07 16:40:18.845 [main] INFO org.hibernate.jpa.internal.util.LogHelper - HHH000204: Processing PersistenceUnitInfo [name: default]
2024-01-07 16:40:18.937 [main] INFO org.hibernate.Version - HHH000412: Hibernate ORM core version 5.6.12.Final
2024-01-07 16:40:19.048 [main] INFO org.hibernate.annotations.common.Version - HCANN000001: Hibernate Commons Annotations {5.1.2.Final}
2024-01-07 16:40:19.122 [main] INFO com.zaxxer.hikari.HikariDataSource - HikariPool-1 - Starting...
2024-01-07 16:40:21.325 [main] INFO com.zaxxer.hikari.HikariDataSource - HikariPool-1 - Start completed.
2024-01-07 16:40:21.337 [main] INFO org.hibernate.dialect.Dialect - HHH000400: Using dialect: org.hibernate.dialect.MySQL8Dialect
2024-01-07 16:40:22.064 [main] INFO o.h.e.t.jta.platform.internal.JtaPlatformInitiator - HHH000490: Using JtaPlatform implementation: [org.hibernate.engine.transaction.jta.platform.internal.NoJtaPlatform]
2024-01-07 16:40:22.072 [main] INFO o.s.orm.jpa.LocalContainerEntityManagerFactoryBean - Initialized JPA EntityManagerFactory for persistence unit 'default'
2024-01-07 16:40:22.495 [main] WARN o.s.b.a.o.j.JpaBaseConfiguration$JpaWebConfiguration - spring.jpa.open-in-view is enabled by default. Therefore, database queries may be performed during view rendering. Explicitly configure spring.jpa.open-in-view to disable this warning
Final Image Path: file:./static/image/
2024-01-07 16:40:22.760 [main] INFO org.apache.coyote.http11.Http11NioProtocol - Starting ProtocolHandler ["http-nio-8080"]
2024-01-07 16:40:22.776 [main] INFO o.s.boot.web.embedded.tomcat.TomcatWebServer - Tomcat started on port(s): 8080 (http) with context path ''
2024-01-07 16:40:22.780 [main] WARN o.s.b.w.s.c.AnnotationConfigServletWebServerApplicationContext - Exception encountered during context initialization - cancelling refresh attempt: org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException
2024-01-07 16:40:22.783 [main] INFO o.s.orm.jpa.LocalContainerEntityManagerFactoryBean - Closing JPA EntityManagerFactory for persistence unit 'default'
2024-01-07 16:40:22.784 [main] INFO com.zaxxer.hikari.HikariDataSource - HikariPool-1 - Shutdown initiated...
2024-01-07 16:40:23.145 [main] INFO com.zaxxer.hikari.HikariDataSource - HikariPool-1 - Shutdown completed.
2024-01-07 16:40:24.562 [main] INFO org.apache.coyote.http11.Http11NioProtocol - Pausing ProtocolHandler ["http-nio-8080"]
2024-01-07 16:40:24.563 [main] INFO org.apache.catalina.core.StandardService - Stopping service [Tomcat]
2024-01-07 16:40:24.566 [main] INFO org.apache.coyote.http11.Http11NioProtocol - Stopping ProtocolHandler ["http-nio-8080"]
2024-01-07 16:40:24.569 [main] INFO org.apache.coyote.http11.Http11NioProtocol - Destroying ProtocolHandler ["http-nio-8080"]
2024-01-07 16:40:24.575 [main] INFO o.s.b.a.l.ConditionEvaluationReportLoggingListener -
Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.
2024-01-07 16:40:24.599 [main] ERROR org.springframework.boot.SpringApplication - Application run failed
org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException
at 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 com.example.DemoApplication.main(DemoApplication.java:10)
Caused by: java.lang.NullPointerException: null
at 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:220)
at java.util.Arrays.sort(Arrays.java:1512)
at java.util.ArrayList.sort(ArrayList.java:1462)
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:1382)
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)
... 14 common frames omitted