swaggerUI 配置扫描多个包路径

最新推荐文章于 2024-09-07 18:23:06 发布

衫凉℃

最新推荐文章于 2024-09-07 18:23:06 发布

阅读量3k

点赞数 3

分类专栏： java

本文链接：https://blog.youkuaiyun.com/qq_41571395/article/details/108389070

版权

java 专栏收录该内容

37 篇文章

订阅专栏

本文介绍如何在Spring Boot项目中使用Swagger2配置SwaggerUI扫描多个包路径，实现API文档的自动化生成。通过定义分隔符，配置Docket组件选择API标签所在位置，包括com.tyzn.controller.api和com.tyzn.controller.backApi两个模块，实现全面的API文档覆盖。

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

swaggerUI 配置扫描多个包路径

package com.tyzn;

import com.google.common.base.Function;
import com.google.common.base.Optional;
import com.google.common.base.Predicate;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
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 jock
 * @Title: Swagger2
 * @ProjectName imooc-videos-dev
 * @Description: TODO
 */

@SuppressWarnings("all")
@Configuration
@EnableSwagger2//开启
public class Swagger2 {
    // 定义分隔符
    private static final String splitor = ";";
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //API标签所在位置
                .apis(basePackage("com.tyzn.controller.api"  + splitor
                        + "com.tyzn.controller.backApi"))
                //.apis(RequestHandlerSelectors.basePackage("com.tyzn.controller.backApi"))
                .paths(PathSelectors.any())
                .build();
    }

    //标题设置
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                //题目
                .title("**********api接口")
                //设置联系人
                .contact(new Contact("**********","http://www.xxx.com","xxxxxx@qq.com"))
                //文档描述
                .description("描述信息")
                //版本号
               .version("1.0").build();
    }

    public static Predicate<RequestHandler> basePackage(final String basePackage) {
        return input -> declaringClass(input).transform(handlerPackage(basePackage)).or(true);
    }

    private static Function<Class<?>, Boolean> handlerPackage(final String basePackage) {
        return input -> {
            // 循环判断匹配
            for (String strPackage : basePackage.split(splitor)) {
                boolean isMatch = input.getPackage().getName().startsWith(strPackage);
                if (isMatch) {
                    return true;
                }
            }
            return false;
        };
    }

    private static Optional<? extends Class<?>> declaringClass(RequestHandler input) {
        return Optional.fromNullable(input.declaringClass());
    }
}