导入依赖:版本随便你选
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
</dependency>
添加核心配置:com.tianfu.system.agent.controller这个扫的是你的controller路径
package com.tianfu.system.agent.Config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
import java.util.List;
/**
* Swagger配置类
*/
@SuppressWarnings("all")
@EnableSwagger2
@Configuration
public class SwaggerConfig extends WebMvcConfigurationSupport {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
//registry.addResourceHandler("/webjars/**")
registry.addResourceHandler("/webjars")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
super.addResourceHandlers(registry);
}
@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping("/**")
.allowedOrigins("*")
.allowedMethods("get", "post", "put", "options", "delete", "patch")
.allowCredentials(true).maxAge(3600);
}
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.groupName("")
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.tianfu.system.agent.controller"))
.paths(PathSelectors.any())
.build();
//添加请求头
//.globalOperationParameters(setHeaderTocken());
}
// private List<Parameter> setHeaderTocken() {
// ParameterBuilder tokenPar = new ParameterBuilder();
// List<Parameter> pars = new ArrayList<>();
// tokenPar.name("Blade-Auth").description("Tocken请求头").modelRef(new ModelRef("String")).parameterType("header").required(false).build();
// pars.add(tokenPar.build());
// return pars;
// }
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("TFCloud云平台接口文档")//标题
.description("")//描述
.version("1.0")//版本号
.build();
}
}
启动类添加注解:
@EnableSwagger2
//这个是扫全部工程下的类 主包
@ComponentScan("com.tianfu")
访问路径;http://ip:端口/swagger-ui.html即可
基于网关聚合文档形式请访问下面这篇文章