Swagger_Swagger配置类实践_batch-【官方】百战程序员_IT在线教育培训机构


xxxxxxxxxx
@Configuration
public class SwaggerConfig {
    
    @Bean
    public Docket getDocket(){
        return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(swaggerDemoApiInfo())
            .select()
            .build();
    }
    
    private ApiInfo swaggerDemoApiInfo(){
        return new ApiInfoBuilder()
            .contact(new Contact("北京尚学堂",           "http://www.bjsxt.com","xxx@163.com"))
        //文档标题
        .title("这里是Swagger的标题")
        //文档描述
        .description("这里是Swagger的描述")
        //文档版本
        .version("1.0.0")
        .build();
    }
}

配置基本信息

配置项	含义
Docket	摘要对象，通过对象配置描述文件的信息。
apiInfo	设置描述文件中 info，参数类型 ApiInfo
select()	返回 ApiSelectorBuilder 对象，通过对象调用 build()可以创建 Docket 对象
ApiInfoBuilder	ApiInfo 构建器

显示效果如下：

设置扫描的包

可以通过 apis()方法设置哪个包中内容被扫描


xxxxxxxxxx
@Bean
public Docket getDocket() {
 return new Docket(DocumentationType. SWAGGER_2)
    .apiInfo(swaggerDemoApiInfo())
    .select()
    .apis(RequestHandlerSelectors.basePackage (         "com.bjsxt.controller"))
    .build();
}

自定义注解设置不需要生成接口文档的方法

注解名称自定义


xxxxxxxxxx
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME )
public @interface NotIncludeSwagger {
}

添加规则

通过下面的代码设置生成规则


xxxxxxxxxx
public ApiSelectorBuilder apis(Predicate<RequestHandler>
selector)

下面的方法表示不允许的条件


xxxxxxxxxx
public static <T> Predicate<T> not(Predicate<T> predicate)

withMethodAnnotation：表示此注解是方法级别注解


xxxxxxxxxx
@Bean
public Docket getDocket(){
    return w new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(swaggerDemoApiInfo())
        .select()
        .paths(allowPaths())
    .apis(not((withMethodAnnotation(NotIncludeSwagger.class)))
        .build();
}

添加NotIncludeSwagger注解

在不需要生成接口文档的方法上面添加@NotIncludeSwagger 注解后，该方法将不会被 Swagger 进行生成在接口文档中。


xxxxxxxxxx
@NotIncludeSwagger
@RequestMapping("/getPeople2")
public People getPeople2(Integer id, String name, String    address){
    People peo = new People();
    peo.setId(id);
    peo.setName(name);
    peo.setAddress(address);
    return peo;
}

设置范围

通过下面的代码


xxxxxxxxxx
public ApiSelectorBuilder paths(Predicate<String> selector)

可以设置满足什么样规则的 url 被生成接口文档。可以使用正则表达式进行匹配。

下面例子中表示只有以/demo/开头的 url 才能被 swagger 生成接口文档。


xxxxxxxxxx
@Bean
public Docket getDocket(){
    return new Docket(DocumentationType. SWAGGER_2 )
        .apiInfo(swaggerDemoApiInfo())
        .select()
        .paths(allowPaths())
        .build();
}
private Predicate<String> allowPaths(){
    return or(regex("/demo/.*"));
}

如何希望全部扫描可以使用


xxxxxxxxxx
paths(PathSelectors.any())

实时效果反馈

1.通过哪个方法设置扫描的包

A apiinfo

B select

C apis

D path

答案

1=>C

Swagger_Swagger配置介绍_batch Swagger_Swagger配置_设置扫描路径_batch

北京市昌平区回龙观镇南店村综合商业楼2楼226室