1.要用到的依赖包:
- <!-- swagger2 依赖 -->
- <dependency>
- <groupId>io.springfox</groupId>
- <artifactId>springfox-swagger2</artifactId>
- <version>2.7.0</version>
- </dependency>
- <!-- Swagger第三方ui依赖 -->
- <dependency>
- <groupId>com.github.xiaoymin</groupId>
- <artifactId>swagger-bootstrap-ui</artifactId>
- <version>1.9.6</version>
- </dependency>
2.代码的实现Config类:
- package com.example.yebsever.config.swagger;
-
- import org.springframework.context.annotation.Bean;
- 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.*;
- import springfox.documentation.spi.DocumentationType;
- import springfox.documentation.spi.service.contexts.SecurityContext;
- import springfox.documentation.spring.web.plugins.Docket;
- import springfox.documentation.swagger2.annotations.EnableSwagger2;
-
- import java.util.ArrayList;
- import java.util.List;
-
- /**
- * Swagger2配置
- */
- @Configuration
- @EnableWebMvc
- @EnableSwagger2
- public class Swagger2Config {
- @Bean
- public Docket createRestApi(){
- return new Docket(DocumentationType.SWAGGER_2)
- .apiInfo(apiInfo())
- .select()
- .apis(RequestHandlerSelectors.basePackage("com.example.yebsever.controller"))
- .paths(PathSelectors.any())
- .build();
- // .securityContexts(securityContexts())
- // .securitySchemes(securitySchemes());
-
- }
-
- private ApiInfo apiInfo(){
- return new ApiInfoBuilder()
- .title("云E办接口文档")
- .description("云E办接口文档")
- .contact(new Contact("xxxx","http:localhost:8088/doc.html","xxxx@xxxx.com"))
- .version("1.0")
- .build();
- }
3.在security中放行Swagger的静态资源配置有时候会应为版本问题出现错误
请按我的方法来写:在启动类加上该方法
- /**
- * 放行Swagger静态文件
- * @param registry
- */
- @Override
- public void addResourceHandlers(ResourceHandlerRegistry registry) {
- registry.addResourceHandler("/doc.html")
- .addResourceLocations("classpath:/META-INF/resources/");
- registry.addResourceHandler("/webjars/**").
- addResourceLocations("classpath:/META-INF/resources/webjars/");
- }
- package com.example.yebsever;
-
- import org.mybatis.spring.annotation.MapperScan;
- import org.springframework.boot.SpringApplication;
- import org.springframework.boot.autoconfigure.SpringBootApplication;
- import org.springframework.scheduling.annotation.EnableScheduling;
- import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
- import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
-
- @SpringBootApplication
- @MapperScan("com.example.yebsever.mapper")
- @EnableScheduling
- public class YebSeverApplication implements WebMvcConfigurer {
- /**
- * 放行Swagger静态文件
- * @param registry
- */
- @Override
- public void addResourceHandlers(ResourceHandlerRegistry registry) {
- registry.addResourceHandler("/doc.html")
- .addResourceLocations("classpath:/META-INF/resources/");
- registry.addResourceHandler("/webjars/**").
- addResourceLocations("classpath:/META-INF/resources/webjars/");
- }
-
-
- public static void main(String[] args) {
- SpringApplication.run(YebSeverApplication.class, args);
- System.out.println("文档接口:http://localhost:8088/doc.html");
- }
-
- }
效果图:
关注,收藏,点赞,有问题可以私信“门主” :v:z13135361785