Swagger2 API文档配置-CSDN博客

本文介绍了一种使用Swagger2在Spring Boot项目中配置API文档的方法。通过创建Swagger2Config类并使用@Configuration和@EnableSwagger2注解，可以为不同的API分组（如webApi和adminApi）生成详细的接口文档。每个分组的文档包括标题、描述、版本和联系人信息，且通过路径选择器限定显示特定路径下的API。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket webApiConfig(){

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                //只显示api路径下的页面
                .paths(Predicates.and(PathSelectors.regex("/api/.*")))
                .build();

    }

    @Bean
    public Docket adminApiConfig(){

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("adminApi")
                .apiInfo(adminApiInfo())
                .select()
                //只显示admin路径下的页面
                .paths(Predicates.and(PathSelectors.regex("/admin/.*")))
                .build();

    }

    private ApiInfo webApiInfo(){

        return new ApiInfoBuilder()
                .title("网站前台-API文档")
                .description("本文档描述了网站微服务接口定义")
                .version("1.0")
                .contact(new Contact("Jimu98", "http://www.jimu98.cn", "z591593455@qq.com"))
                .build();
    }

    private ApiInfo adminApiInfo(){

        return new ApiInfoBuilder()
                .title("后台管理系统-API文档")
                .description("本文档描述了后台管理系统微服务接口定义")
                .version("1.0")
                .contact(new Contact("Helen", "http://www.jimu98.cn", "z591593455@qq.com"))
                .build();
    }
}