目录
POM
SwaggerConfig
SwaggerUI
Spring 5 + Swagger2
POM
<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>
SwaggerConfig
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Controller;
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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;@Configuration
@EnableSwagger2
@EnableWebMvc
public class SwaggerConfig {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.shubing")) //指定包下面的所有controller//.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class)) 只显示指定的controller, @restController @Controller.paths(PathSelectors.any()).build();}private ApiInfo apiInfo(){return new ApiInfoBuilder().title("SwaggerDemo API DOC").description("SwaggerDemo API DOC").version("1.0") .termsOfServiceUrl("https://www.baidu.com") .build(); }
}
SwaggerUI
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;@Configuration
@EnableWebMvc
public class SwaggerUI implements WebMvcConfigurer{@Overridepublic void addResourceHandlers(ResourceHandlerRegistry registry) {registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");}
}
遇到的问题:
下面url访问正常,但是swagger-ui.html 访问404
http://localhost:8080/contentroot/v2/api-docs 访问正常
http://localhost:8080/contentroot/swagger-resources/configuration/ui 访问正常
http://localhost:8080/contentroot/swagger-ui.html 404
解决方案:
在SwaggerConfig和SwaggerUI中使用@EnableWebMvc
pom版本使用2.9.2, 高版本不适用