Swagger2 生成 Spring Boot API 文档

最新推荐文章于 2025-06-30 10:16:42 发布

原创

最新推荐文章于 2025-06-30 10:16:42 发布 · 3.8k 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#spring #api #文档

本文详述如何在Spring Boot项目中使用Swagger2来生成和维护RESTful API文档。通过添加POM依赖，配置Swagger类，指定扫描包名，访问/v2/api-docs获取JSON文档，并利用Swagger UI展示直观的接口文档。同时介绍了@ApiOperation，@ApiParam等注解的应用。

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

Swagger2 生成 Spring Boot API 文档

Swagger2 生成 Spring Boot API 文档

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。本文主要介绍了在 Spring Boot 添加 Swagger 支持，生成可自动维护的 API 文档。

POM 文件

首先我们需要修改工程的 POM 文件 , 添加 Swagger 的 JAR 包 springfox-swagger2 swagger-annotations。


         <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>

        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-annotations</artifactId>
            <version>1.5.13</version>
        </dependency>