使用Swagger2配置多个basePackage的方法

Spring Boot中Swagger2配置多模块API
最新推荐文章于 2025-01-12 23:52:42 发布
最新推荐文章于 2025-01-12 23:52:42 发布
阅读量1.4k 收藏 1
点赞数 1
CC 4.0 BY-SA版权
文章标签： java spring boot 开发语言 Java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/CyberByte/article/details/132329782
Java 专栏收录该内容
125 篇文章 ¥59.90 ¥99.00
订阅专栏
本文介绍了如何在Spring Boot项目中使用Swagger2配置多个basePackage，以包含不同模块的API接口。通过添加Swagger2依赖，启用@EnableSwagger2注解，创建Swagger2配置类并指定多个basePackage，可以生成包含所有模块接口的API文档。

使用Swagger2配置多个basePackage的方法

Swagger2是一个用于生成API文档和进行API测试的工具，它能够自动生成API文档，并提供了一系列强大的功能来管理和测试API接口。在Spring Boot项目中使用Swagger2进行API文档的生成是非常方便的，但是有时候我们的项目会有多个模块，而每个模块都有自己的API接口，这就需要配置多个basePackage。

下面将介绍如何使用Swagger2配置多个basePackage。

首先，我们需要在我们的Spring Boot项目中添加Swagger2的依赖。在pom.xml文件中，添加以下依赖：

<dependency>
    <groupId>io.springfox</groupId
了解本专栏 订阅专栏 解锁全文
SpringBoot 入门到精通-Swagger2 配置多个basePackage
隔壁老瓦的专栏
08-23 5509
@Bean(value = "defaultApi2") public Docket defaultApi2() { Docket docket=new Docket(DocumentationType.SWAGGER_2) .globalResponseMessage(RequestMethod.GET, responseMessageList) .globalResponseMessage(RequestMethod.POST, response.
SpringBoot集成Swagger2并配置多个包路径扫描
qq_36763236的博客
03-06 2188
1. 简介 随着现在主流的前后端分离模式开发越来越成熟，接口文档的编写和规范是一件非常重要的事。简单的项目来说，对应的controller在一个包路径下，因此在Swagger配置参数时只需要配置一个包路径即可。但是对于复杂的项目，往往需要分模块开发，因此对应的controller包存在多个，所以需要在Swagger配置参数时需要指定多个包路径扫描。   在一些普遍情况下，分模块开发时由不同的开发小组来完成，为了保证接口文档的风格统一和方便，在公共模块指定统一的配置工具类，其他模块只需要配置自己的模块名称、编
swagger 配置多个basePackage
Markix的博客
04-21 7232
@Bean public Docket taskUiApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(new ApiInfoBuilder().title("Task UI API").build()) .groupName("Task UI API") .select() ...
Swagger2 配置多个basePackage
qq_44795091的博客
04-21 608
swagger2配置扫多个包
博客
03-18 4225
简单记录下，网上搜到几个都比较麻烦 @Bean(value = "defaultApi2") public Docket defaultApi2() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() //此包路径下的类，才生成接口文档 .apis(R
新版Swagger配置映射多个包的controller
qq_45546333的博客
06-28 835
.apis(Predicates.or( RequestHandlerSelectors.basePackage("com.aa.controller"), RequestHandlerSelectors.basePackage("com.aa.controller2") ))
多个微服务配置和使用Swagger进行单元测试
m0_53698336的博客
12-17 1539
@ComponentScan注解 Spring中@ComponentScan注解的作用就是根据定义的扫描路径，把符合扫描规则的类装配到spring的bean容器中。 源码 basePackages与value:? 用于指定包的路径，进行扫描 basePackageClasses: 用于指定某个类的包的路径进行扫描 nameGenerator: bean的名称的生成器 useDefaultFilters: 是否开启对@Component，@Repository，@Service，@Controller的..
Swagger——【SpringBoot集成Swagger、配置Swagger、配置扫描接口、配置API分组】
2401_89191885的博客
01-12 897
select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口。.select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口。.select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口。.enable(false) //配置是否启用Swagger，如果是false，在浏览器将无法访问。
SpringBoot 2.2.5 整合Swagger 2.9.2，实现扫描多个不同包的接口，并配置支持传参Token进行验证
qq_43659871的博客
12-20 1594
【代码】SpringBoot 2.2.5 整合Swagger 2.9.2，实现扫描多个不同包的接口，并配置支持传参Token进行验证。
jeecg-boot怎么配置swagger扫描多个包？
qq_38215042的博客
07-14 1857
1：重写basePackage方法 // 定义分隔符 private static final String splitor = ";"; @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() //此包路径下的类，才生成接口文档 // .apis(RequestHandlerSelecto
Swagger：swagger扫描不同包的controller
Jcsim~
10-31 5167
一、错误方法，使用 io.renren.modules.*.controller public Docket createRestApi() { log.info("======================== 当前环境是否开启Swagger：" + SwaggerSwitch + " ========================"); return new Docket(DocumentationType.SWAGGER_2) .
swagger多包扫描
white_ShiKu的博客
07-30 1975
swagger的搭建与使用 关于搭建与使用，如果大家还不清楚的话，可以去看看我的上一篇文章 swagger 多包扫描 在开发中我们可能不需要扫描全部的包，可能只需要扫描部分包 环境 现在在swagger包下有分别有controller1和controller2两个包，现在只需要扫描这两个包，但又不能把swagger包下全部内容扫描 重写包扫描方法 由于使用RequestHandlerSelecto...
Spring boot集成Swagger，并配置多个扫描路径
努力努力再努力
07-06 1392
@Configuration @EnableSwagger2 public class SwaggerConfig { // 定义分隔符 private static final String splitor = ";"; /** * 创建API应用 * api() 增加API相关信息 * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现， * 本例采用指定扫描的包路径.
Swagger 配置多个接口文档实现 和 实现多包扫描的配置方式
梦若辰宇的博客
09-01 3813
swagger配置多个接口文档 swagger实现多包扫描
swagger2多包扫描
qq_28480349的博客
04-16 503
swagger类，单包扫描 // swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等 @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select()
SpringBoot-集成swagger2
上海一九四三
09-19 360
在工作中，一个Web管理系统通常都是前后端分离的。有专门的前端开发，也有专门的后端开发，甚至有些项目可能还会要求有专门的接口开发，这类人通常就只是定义接口规范，然后由后端开发实现。那么问题来了，当一个项目需要这么多人协助完成时，我们就必须有统一的文档来约定一些规范。 对于一个接口来说，我们要定义请求方法，请求参数，参数的属性（如是否允许为空），响应体以及响应码的含义等等。传统的做法就是我们新建一...
Python中的__new__和__init__初始化的区别
rosefun96的博客
10-14 429
__init__ 方法为初始化方法, __new__方法才是真正的构造函数。 1、__new__方法默认返回实例对象供__init__方法、实例方法使用。 class Human2(object): def __init__(self,age,sex): self.age = age self.sex = sex print("self", self) def speak(self): print("I am:",self.age,self.sex) 示例： h = Hum
Swagger 2 的配置与使用（亲测有效）
一天不写代码难受的博客
08-21 1451
swagger2
Swagger 配置类指定了多个扫描路径吗
最新发布
09-03
Swagger 配置类可以指定多个扫描路径。在 Spring 中使用 Swagger 时，通过`RequestHandlerSelectors.basePackage`方法来指定扫描的包路径，若要指定多个扫描路径，可以使用`RequestHandlerSelectors.or`方法将多个路径组合起来。 以下是一个示例代码： ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket creatResetApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.or( RequestHandlerSelectors.basePackage("com.example.controller"), RequestHandlerSelectors.basePackage("com.example.service") )) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("swagger 构建接口文档") .description("测试用例") .termsOfServiceUrl("http://www.baidu.com") .version("1.0") .build(); } } ``` 在上述代码中，`RequestHandlerSelectors.or`方法将`com.example.controller`和`com.example.service`两个包路径组合在一起，这样 Swagger 就会同时扫描这两个包下的类。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符  | 博主筛选后可见
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值