Java实战：Spring Boot集成Swagger3_springboot集成swagger3

本文将详细介绍如何在Spring Boot应用程序中集成Swagger3，以构建现代化的RESTful API文档。我们将探讨Swagger3的基本概念，以及如何使用Spring Boot和Swagger3库来实现API文档。此外，我们将通过具体的示例来展示如何在Spring Boot中配置和使用Swagger3。本文适合希望使用Swagger3为Spring Boot应用程序生成API文档的开发者阅读。

一、引言

在现代Web开发中，RESTful API文档是一个重要的组成部分。Swagger是一个流行的API框架，用于构建、描述、消费RESTful服务。Swagger3是Swagger的下一代，它提供了更简洁、更强大的功能，以满足现代API的需求。Spring Boot提供了对Swagger3的直接支持，使得集成和使用Swagger3变得非常简单。

二、Swagger3的基本概念

1. 什么是Swagger3？
Swagger3是一个用于构建、描述、消费RESTful服务的框架。它提供了一套完整的工具，用于生成API文档、自动生成客户端SDK、进行API测试等。Swagger3支持OpenAPI 3.0规范，使得API文档更加丰富和交互式。
2. Swagger3的特点

• 现代化：Swagger3提供了更加简洁、现代的API文档界面。
• 交互式：Swagger3支持交互式API测试，用户可以在线发送请求和查看响应。
• 可扩展性：Swagger3支持多种插件和扩展，以满足不同的需求。
• 社区支持：Swagger3拥有一个庞大的社区，提供了丰富的资源和工具。

三、在Spring Boot中集成Swagger3

1. 添加Swagger3依赖
在项目的pom.xml文件中，添加Spring Boot的Swagger3依赖：

<dependencies>
    <!-- Spring Boot Web依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- Spring Boot OpenAPI依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-openapi</artifactId>
        <version>3.0.0</version>
    </dependency>
</dependencies>
1
2
3
4
5
6
7
8
9
10
11
12
13

2. 配置Swagger3
Spring Boot会自动配置Swagger3，但我们可以通过在application.properties或application.yml文件中添加一些属性来定制Swagger3的行为。例如：

# application.properties
spring.mvc.static-path-pattern=/static/**
1
2

3. 创建Swagger3配置类
虽然Spring Boot会自动配置Swagger3，但我们也可以通过创建一个Swagger3配置类来进一步定制Swagger3的行为。以下是一个简单的Swagger3配置类示例：

package com.example.demo.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.oas.annotations.EnableOpenApi;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
@EnableOpenApi
public class SwaggerConfig {
    @Bean
    public Docket apiDocket() {
        return new Docket(DocumentationType.OAS_30)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

在上面的代码中，我们创建了一个Docket Bean，用于配置Swagger3的文档类型为OAS 3.0，并选择com.example.demo.controller包下的API进行文档生成。
4. 创建Controller类
在Spring Boot项目中创建一个Controller类，用于提供RESTful API。以下是一个简单的Controller类示例：

package com.example.demo.controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class SampleController {
    @GetMapping("/hello")
    public String hello() {
        return "Hello, World!";
    }
}
1
2
3
4
5
6
7
8
9
10

5. 运行项目
将以上代码添加到我们的Spring Boot项目中，并运行项目。我们可以通过浏览器或Postman等工具访问http://localhost:8080/swagger-ui/，观察Swagger3 UI界面的渲染效果。

四、Swagger3的高级用法

1. 添加API信息
Swagger3允许您添加API信息，如标题、描述、版本等。我们可以在Swagger3配置类中添加以下代码来设置API信息：

@Bean
public Docket apiDocket() {
    return new Docket(DocumentationType.OAS_30)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
            .paths(PathSelectors.any())
            .build()
            .apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("Spring Boot + Swagger3 API Documentation")
            .description("This is the API documentation for the Spring Boot application.")
            .version("1.0.0")
            .build();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

2. 添加分组
Swagger3支持为API文档添加分组，以便更好地组织和管理API。我们可以在Swagger3配置类中添加以下代码来设置分组：

@Bean
public Docket apiDocket() {
    return new Docket(DocumentationType.OAS_30)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
            .paths(PathSelectors.any())
            .groupName("sample-group")
            .build()
            .apiInfo(apiInfo());
}
1
2
3
4
5
6
7
8
9
10

3. 添加响应示例
Swagger3允许您为API响应添加示例，以便用户更好地理解API的返回值。我们可以在Swagger3配置类中添加以下代码来设置响应示例：

@Bean
public Docket apiDocket() {
    return new Docket(DocumentationType.OAS_30)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
            .paths(PathSelectors.any())
            .build()
            .apiInfo(apiInfo())
            .globalResponses(HttpMethod.GET, responseListBuilder -> responseListBuilder
                    .addResponse(HttpStatus.OK.value(), "success", new ObjectMapper().writeValueAsString(new SampleResponse())));
}
private class SampleResponse {
    private String status;
    private String message;
    // getter和setter方法
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

五、总结

本文详细介绍了如何在Spring Boot应用程序中集成Swagger3，以构建现代化的RESTful API文档。我们首先了解了Swagger3的基本概念和特点。然后，我们学习了如何使用Spring Boot和Swagger3库来实现API文档，并通过具体的示例展示了如何在Spring Boot中配置和使用Swagger3。
通过本文，我们应该已经掌握了如何在Spring Boot中集成和使用Swagger3来生成API文档。我们学会了如何配置Swagger3，如何为API添加信息、分组和响应示例。希望本文能够帮助您在开发Spring Boot应用程序时更加得心应手。如果您有任何疑问或建议，请随时留言交流。