SpringBoot使用Swagger生成多模块的API文档

更新时间：2025年02月14日 10:04:00 作者：五行星辰

这篇文章将以 Spring Boot 多模块项目为例,为大家详细介绍一下如何使用 Swagger 生成多模块的 API 文档,感兴趣的小伙伴可以了解一下

在大型项目中，通常会采用多模块的架构设计，以提高代码的可维护性和可扩展性。使用 Swagger 为多模块项目生成 API 文档时，需要进行一些特殊的配置。以下以 Spring Boot 多模块项目为例，详细介绍如何使用 Swagger 生成多模块的 API 文档。

项目结构

假设我们有一个包含多个模块的 Spring Boot 项目，结构如下：

multi-module-project
├── common-module
│ └── src
│ └── main
│ └── java
│ └── com
│ └── example
│ └── common
│ └── ...
├── module-a
│ └── src
│ └── main
│ └── java
│ └── com
│ └── example
│ └── modulea
│ └── ...
├── module-b
│ └── src
│ └── main
│ └── java
│ └── com
│ └── example
│ └── moduleb
│ └── ...
└── api-gateway
└── src
└── main
└── java
└── com
└── example
└── apigateway
└── ...

步骤 1：添加依赖

在每个需要生成 API 文档的模块的 pom.xml 中添加 Swagger 相关依赖：

<dependencies>
    <!-- Swagger API 注解 -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>
    <!-- Swagger UI -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>
</dependencies>

步骤 2：配置 Swagger

在每个模块中创建 Swagger 配置类，例如在 module-a 中：

package com.example.modulea.config;
 
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
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 api() {
        return new Docket(DocumentationType.SWAGGER_2)
               .select()
               .apis(RequestHandlerSelectors.basePackage("com.example.modulea.controller"))
               .paths(PathSelectors.any())
               .build();
    }
}

在 module-b 中也进行类似的配置，只需将 basePackage 替换为 com.example.moduleb.controller。

步骤 3：统一 API 网关配置（可选）

如果项目中有 API 网关模块（如 api-gateway），可以在该模块中配置 Swagger，将各个模块的 API 文档聚合在一起。

package com.example.apigateway.config;
 
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
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 api() {
        return new Docket(DocumentationType.SWAGGER_2)
               .select()
               .apis(RequestHandlerSelectors.basePackage("com.example"))
               .paths(PathSelectors.any())
               .build();
    }
}

这里的 basePackage 设置为包含所有模块控制器的根包，这样 Swagger 会扫描该包下所有模块的控制器，并生成统一的 API 文档。

步骤 4：添加 API 注解

在每个模块的控制器类和方法上添加 Swagger 注解，以描述 API 信息。例如在 module-a 的控制器中：

package com.example.modulea.controller;
 
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
@RequestMapping("/module-a")
@Api(value = "Module A API", description = "这是 Module A 的 API 文档")
public class ModuleAController {
    @GetMapping("/hello")
    @ApiOperation(value = "获取 Module A 的问候语", notes = "返回一个简单的问候语")
    public String hello() {
        return "Hello from Module A!";
    }
}

在 module-b 的控制器中也进行类似的操作。

步骤 5：查看 API 文档

启动各个模块的 Spring Boot 应用程序，访问相应模块的 Swagger UI 地址（如 http://localhost:8080/module-a/swagger-ui.html 或 http://localhost:8080/api-gateway/swagger-ui.html，端口号和路径根据实际情况修改），即可查看各个模块或统一的 API 文档。

注意事项

确保每个模块的 Swagger 配置类中的 basePackage 配置正确，以确保能够扫描到相应模块的控制器。

如果使用 API 网关进行文档聚合，要注意网关的路由配置，确保能够正确访问各个模块的 API。

可以根据需要对 Swagger 的配置进行定制，如设置文档标题、描述、版本等信息。

通过以上步骤，你可以为 Spring Boot 多模块项目使用 Swagger 生成清晰、统一的 API 文档，方便开发和测试人员查看和使用。

到此这篇关于SpringBoot使用Swagger生成多模块的API文档的文章就介绍到这了,更多相关SpringBoot Swagger生成API文档内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

利用Java读取Word表格中文本和图片的方法实例
这篇文章主要给大家介绍了关于如何利用Java读取Word表格中文本和图片的相关资料,主要利用的是free spire.doc.jar 包,文中通过图文介绍的非常详细,需要的朋友可以参考下
2021-07-07
java+MongoDB实现存图片、下载图片的方法示例
这篇文章主要介绍了java+MongoDB实现存图片、下载图片的方法,结合实例形式详细分析了java结合MongoDB实现图片的存储与下载相关操作技巧,需要的朋友可以参考下
2019-09-09
SpringBoot实现动态控制定时任务支持多参数功能
这篇文章主要介绍了SpringBoot实现动态控制定时任务-支持多参数功能，本文通过实例代码给大家介绍的非常详细，具有一定的参考借鉴价值,需要的朋友可以参考下
2019-05-05
利用MultipartFile实现文件上传功能
这篇文章主要为大家详细介绍了利用MultipartFile实现文件上传功能，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-11-11
Eclipse中如何显示explorer过程解析
这篇文章主要介绍了Eclipse中如何显示explorer过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-09-09
通过RedisTemplate连接多个Redis过程解析
这篇文章主要介绍了通过RedisTemplate连接多个Redis过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-08-08
java finally块执行时机全面分析
下面小编就为大家带来一篇java finally块执行时机全面分析。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2016-08-08
Spring Cloud学习教程之DiscoveryClient的深入探究
这篇文章主要给大家介绍了关于Spring Cloud学习教程之DiscoveryClient的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧。
2018-04-04
java8 时间日期的使用与格式化示例代码详解
这篇文章主要介绍了java8 时间日期的使用与格式化,本文通过示例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2022-06-06
SpringBoot监控模块Actuator的用法详解
Spring Boot Actuator 是 Spring Boot 自带的一个功能模块，提供了一组已经开箱即用的生产环境下常用的特性和服务，比如应用程序的健康检查、信息暴露、度量收集、日志记录等，本文将给大家详细SpringBoot监控模块Actuator的用法
2023-06-06