Spring Boot 集成 Swagger 生成 RESTful API 文档

最新推荐文章于 2024-09-07 22:27:57 发布

Michael翔

最新推荐文章于 2024-09-07 22:27:57 发布

阅读量319

点赞数

分类专栏： Java Spring Boot 文章标签： Spring Boot Java API RESTful Swagger

本文链接：https://blog.csdn.net/michael_728/article/details/96567964

版权

本文介绍了如何在 Spring Boot 项目中集成 Swagger，以自动生成 RESTful API 文档。Swagger 提供了 Swagger Editor、Swagger UI 和 Swagger Codegen 等工具，简化了 REST API 的设计和使用。文章详细讲解了添加依赖、配置 Swagger、编写 Controller 类以及 Swagger 的主要注解。此外，还探讨了 RESTful API 的设计原则，包括资源操作和信息过滤。

摘要由CSDN通过智能技术生成

简介

Swagger 官网是这么描述它的：The Best APIs are Built with Swagger Tools。

Swagger 是一套基于 OpenAPI 规范构建的开源工具，可以帮助我们设计、构建、记录以及使用 Rest API。Swagger 主要包含了以下三个部分：

Swagger Editor：基于浏览器的编辑器，我们可以使用它编写我们 OpenAPI 规范。
Swagger UI：它会将我们编写的 OpenAPI 规范呈现为交互式的 API 文档，后文我将使用浏览器来查看并且操作我们的 Rest API。
Swagger Codegen：它可以通过为 OpenAPI（以前称为 Swagger）规范定义的任何 API 生成服务器存根和客户端 SDK 来简化构建过程。

Spring Boot 使得开发 RESTful 服务变得简单。那么编写 Spring Boot 接口，为何要用 Swagger 呢？

代码改变，文档就会改变。只需要少量的注释，Swagger 就可以根据代码自动生成 API 文档。
Swagger UI 是一份交互式的 API 文档，可以直接在 Web 界面调用 API。这里有一份 Swagger UI 的 Live Demo，看看官方是怎么写 RESTful API 的。

添加依赖

pom.xml 引入 Swagger 相关的依赖：

<!-- swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>${swagger.version}</version>
</dependency>
<!-- swagger2 ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>${swagger.version}</version>
</dependency>

使用 property 定义了 Swagger 的版本，因此还需要添加：

<swagger.version>2.9.2</swagger.version>

依赖说明：

springfox-swagger2 Swagger 的 Java 实现
springfox-swagger-ui Swagger UI 页面的依赖

Swagger 配置类

使用注解 @Configuration 编写 Swagger 配置类—— SwaggerConfig。

新建 config 的包，创建 SwaggerConifg 的配置类：

//通过@Configuration注解，让Spring来加载该类配置
@Configuration
//通过@EnableSwagger2注解来启用Swagger2
@EnableSwagger2
//@ConditionalOnExpression 为Spring的注解，用户是否实例化本类，用于是否启用Swagger的判断（生产环境需要屏蔽Swagger）
@ConditionalOnExpression("${swagger.enable:true}")
public class SwaggerConfig {
   

    // select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现，本例采用指定扫描的包路径来定义，
    // Swagger会扫描该包下所有Controller定义的API，并产生文档内容（除了被@ApiIgnore指定的请求）
    @Bean
    public Docket createRestApi() {
   
        // apiInfo()用来创建该Api的基本信息（这些基本信息会展现在文档页面中
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("标题: Spring Boot 项目集成 Swagger 示例文档")
                .description("描述: 我的博客地址是 https://michael728.github.io")
                .termsOfServiceUrl("https://michael728.github.io/")
                .version("1.0")
                .build();

        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo