这里写自定义目录标题
SpringBoot集成Swagger2配置
package com.cn.rbo.saas.conf;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
*
* @author liuzhihao
* @description:swagger-ui配置类
* @date 2024/02/27
*/
@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class SwaggerUIConfiger {
private ApiInfo apiInfo() {
Contact contact = new Contact("睿博软件","localhost:8082","[email protected]");
return new ApiInfoBuilder()
.contact(contact)
.title("睿博SAAS系统接口文档")
.description("接口说明")
.license("").build();
}
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo()) // 用来展示该 API 的基本信息
.select() // 返回一个 ApiSelectorBuilder 实例,用来控制哪些接口暴露给 Swagger 来展现
.apis(RequestHandlerSelectors.basePackage("com.cn.rbo.saas.controller")) // 配置包扫描路径(根据自己项目调整,通常配置为控制器路径)
.paths(PathSelectors.any()) //
.build();
}
}
本项目集成的是增强版的Swagger文档,使用的增强版的UI
com.github.xiaoymin
POM配置文件
<properties>
<!-- Java版本 -->
<java.version>1.8</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<!-- swagger-ui在线调试工具版本;通过${swagger.version}来使用 -->
<springfox-swagger2.version>2.9.2</springfox-swagger2.version>
<swagger-bootstrap-ui.version>1.9.4</swagger-bootstrap-ui.version>
</properties>
<!-- 定义的依赖清单,有所依赖包都需要写在这个标签里面 -->
<dependencies>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${springfox-swagger2.version}</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>${swagger-bootstrap-ui.version}</version>
</dependency>
<!-- 国际版 -->
<!--<dependency>
<groupId>rbo.cn.com.nssoftware.swagger</groupId>
<artifactId>swagger-bootstrap-ui-jboost</artifactId>
<version>${swagger-bootstrap-ui.version}</version>
</dependency>-->
</dependencies>
按照上面的配置,在本地测试效果是正常的
在红色标记的地方是正常显示的,但是按照这个配置打war包部署到服务器或者本地的tomcat中就会出现404的现象。
出现上面的这种情况时,看过很多网上的帖子说什么配置有问题,或者路劲的问题的都解决不了问题,这个问题的跟本在于Servlet的Dispatcher的问题。
需要修改SpringBoot的启动类
@SpringBootApplication
@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
public class BootStart extends SpringBootServletInitializer {
public static void main(String[] args) {
SpringApplication.run(BootStart.class, args);
}
@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
return builder.sources(BootStart.class);
}
}
主要是继承
SpringBootServletInitializer
并且重写
@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
return builder.sources(BootStart.class);
}
这样在进行打包,并且去部署
就可以正常访问了,找到这个原因的根本在于看到一篇帖子描述,SpringBoot内置的tomcat问题,就去尝试,去掉Springboot内置的tomcat,安装一个tomcat到编译器器,并且通过SpringMVC的时候的部署方式,把SpringBoot项目部署到tomat上面进行调试看到日志发现的问题。
版权归原作者 别抓我不支援 所有, 如有侵权,请联系我们删除。