/**
* <p>
* Swagger配置类
* </p>
*
* @author jiangwh
* @param: * @param null
* @return:
* @since 2021/4/16
*/
@Configuration
@EnableSwagger2 // 开启Swagger2
public class SwaggerConfig {
//这里还可以配置多个Docket实例表示不用的组。
// 配置Swagger的Docket实例
@Bean
public Docket docket(Environment environment) {
// 获取当前环境的Profiles对象,如果获取到说明是dev环境否则返回null。
Profiles profiles = Profiles.of("dev");
// 如果Profiles不为null返回true,否则返回false。
boolean isDev = environment.acceptsProfiles(profiles);
return new Docket(DocumentationType.SWAGGER_2)// 指定Swagger版本
.apiInfo(apiInfo())
.groupName("ginger")
.enable(isDev) // 是否启用 Swagger 如果禁用在浏览器中就不能访问接口文档0
.select()
// RequestHandlerSelectors:配置扫描接口的方式。
// basePackage:指定要扫描的包。
// any():扫描全部。
// none():不扫描。
// withClassAnnotation:扫描类上的注解,参数是一个注解的反射对象。
// withMethodAnnotation:扫描方法上的注解。
// 如果这里指定的是扫描全部的话,接口文档会出现一个Swagger自己生成接口文档,这个不是我需要的,所以还是指定扫描基本包更好。
.apis(RequestHandlerSelectors.basePackage("com.medbotsurgical.videoclassify.controller"))
// 要过滤的路径
//.paths(PathSelectors.ant("/**")) // 暂时不需要
.build();
}
// 配置Swagger信息在apiInfo中可以指定
private ApiInfo apiInfo() {
Contact contact = new Contact("作者", null, "ginger_mr@163.com");
return new ApiInfo("视频分类接口文档!",
"视频分类接口文档!",
"v1.0",
null,
contact,
"Apache 2.0",
"http://www.apache.prg/licenses/LICENSE-2.0",
new ArrayList());
}
}
Swagger
最新推荐文章于 2024-07-02 15:32:45 发布