springboot集成swagger-bootstrap-ui

mac2024-05-10  5

1、导入pom依赖

<!--swagger-api 依赖开始--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>swagger-bootstrap-ui</artifactId> <version>1.9.3</version> </dependency> <!--swagger-api 依赖结束-->

2、创建配置文件 项目中创建一个目录,创建配置文件

2.1、swaggerConfig

package com.mr.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.EnableWebMvc; 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; /** * Created by 51589 on 2019/10/31. */ @Configuration //必须存在 @EnableSwagger2 //必须存在 public class swaggerConfig { @Bean public Docket customDocket(){ return new Docket(DocumentationType.SWAGGER_2) .enable(true) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.mr.controller")) //当前包路径 .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { Contact contact = new Contact("许震", "http://www.xuzhen2019.xyz", "515897959@qq.com"); return new ApiInfoBuilder() .title("许震测试API接口")//标题 .description("这是一个测试项目文档")//文档接口的描述 .contact(contact) .version("1.1.0")//版本号 .build(); } }

2.2、WebMvcConfig

package com.mr.config; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; import springfox.documentation.spring.web.SpringfoxWebMvcConfiguration; /** * Created by 51589 on 2019/10/31. */ @SpringBootApplication @ConditionalOnClass(SpringfoxWebMvcConfiguration.class) public class WebMvcConfig implements WebMvcConfigurer{ @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/"); registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/"); } }

3、访问 简单在配置接口路径包下写几个接口测试就好 http://localhost:8080/doc.html

截图:

最新回复(0)