springboot项目接口查看swagger文档
1、引入gav如下
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-models</artifactId>
<version>1.6.2</version>
</dependency>
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.6.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-spring-web</artifactId>
<version>2.9.2</version>
</dependency>
<!--添加swagger-ui-layer 文档进行换肤-->
<dependency>
<groupId>com.github.caspar-chen</groupId>
<artifactId>swagger-ui-layer</artifactId>
<version>1.1.3</version>
</dependency>
2、SwaggerConfig自定义
@Configuration
@EnableSwagger2
public class SwaggerConfig extends WebMvcConfigurationSupport {
@Value("${swagger.enable}")
private boolean swaggerEnable;
@Value("${swagger.description}")
private String description;
@Value("${swagger.title}")
private String title;
@Value("${swagger.license}")
private String license;
@Value("${swagger.contract.name}")
private String name;
@Value("${swagger.contract.url}")
private String url;
@Value("${swagger.contract.email}")
private String email;
private String staticResource[]= {"classpath:/META-INF/resources/"
, "classpath:/resources/"
, "classpath:/static/"
, "classpath:/public/"};
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(
new ApiInfoBuilder()
.title(title)
.description(description)
.version(DocumentationType.SWAGGER_2.getVersion())
.license(license)
.contact(new Contact(name,url,email))
.build())
.select().apis(RequestHandlerSelectors.basePackage("com.jmyd.yuexiu.controller")).build();
}
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
if (swaggerEnable) {
registry.addResourceHandler("/**")
.addResourceLocations(staticResource);
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
super.addResourceHandlers(registry);
}
}
}
3、需要注意事项,
1)、swagger文档在设置的过程中可能会因为gav引入版本过低而造成的错误,
2)、引入easeui需要对资源文件访问路径拦截重新注入设置。