1.Swagger2的基础配置(基于SpringBoot)
@Configuration
@EnableSwagger2
public class Swagger2Config {
// swagger2的访问路径:http://localhost:8080/swagger-ui/index.html
/**
* 配置 swagger2 核心配置 docket
* @return 核心配置
*/
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2) // 指定api类型为swagger2
.apiInfo(apiInfo()) // 用于定义api文档汇总信息
.select()
.apis(RequestHandlerSelectors.basePackage("com.xxx.controller")) // 指定controller路径
.paths(PathSelectors.any()) // 所有的controller
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Swagger2 接口api") // 文档页标题
.contact(new Contact("联系人",
"网址",
"邮箱")) // 联系人信息
.description("为前端提供的api文档") // 详细信息
.version("1.0.1") // 文档版本号
.termsOfServiceUrl("网站地址") // 网站地址
.build();
}
}