SpringBoot之Swagger2集成

io.springfox
springfox-swagger2
2.8.0


io.springfox
springfox-swagger-ui
2.8.0

import org.springframework.context.annotation.Configuration;
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;
/**
* @author zhangboqing
* @date 2018/8/6
*
* swagger2配置
*
* 访问地址：
* http://localhost:8080/swagger-ui.html
*/
@Configuration
@EnableSwagger2
public class Swagger2Config {
@Bean
public Docket docket() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
//当前包路径
.apis(RequestHandlerSelectors.basePackage("com.zbq.springbootbase.controller"))
.paths(PathSelectors.any()).build();
}
//构建api文档的详细信息函数
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
//页面标题
.title("springboot-base-frame,使用Swagger2构建RESTful API")
//创建人
.contact(new Contact("张波清", "756623607@qq.com", ""))
//版本号
.version("1.0")
//描述
.description("API 描述")
.build();
}
}

/**
* @author zhangboqing
* @date 2018/9/24
*/
@RestController
public class TestController {
@ApiOperation(value="测试", notes="这是一个简单测试方法")
@PostMapping(value = "/test")
public String test(@RequestHeader String myHeader,String myName) {
System.out.println("----------->header测试");
System.out.println(myHeader);
System.out.println(myName);
return myHeader;
}
}

/**
* @author zhangboqing
* @date 2018/8/7
*
* 注册拦截器
*/
@Configuration
public class ApiSecurityConfig2 implements WebMvcConfigurer {
@Bean
LoggingInterceptor loggingInterceptor() {
return new LoggingInterceptor();
}
/**
* 拦截请求
*
* @param registry
*/
@Override
public void addInterceptors(InterceptorRegistry registry) {
//注册日志拦截器
registry.addInterceptor(loggingInterceptor())
//添加需要拦截的路径
.addPathPatterns("/**")
.excludePathPatterns("/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui.html/**");
}
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
/**
* 跨域配置
*
* @param registry
*/
@Override
public void addCorsMappings(CorsRegistry registry) {
// registry.addMapping("/**")
// // TODO 这里跨域最好配置域名
// .allowedOrigins("*")
// .maxAge(3600)
// .allowCredentials(true)
// .allowedMethods("GET", "POST", "OPTIONS");
}
}