构建可扩展的 RESTful API：Spring Boot 与 Swagger 整合-CFANZ编程社区

在现代的应用程序中，构建可扩展的 RESTful API 是至关重要的，它为不同平台和客户端提供了统一的接口。Spring Boot 作为一个流行的框架，与 Swagger 的整合可以帮助开发人员轻松地设计、文档化和测试 API，提高开发效率。本篇博客将深入探讨如何在 Spring Boot 中整合 Swagger。

1. Swagger 简介

Swagger 是一个开源工具，用于设计、构建和文档化 RESTful API。它提供了一个交互式的文档界面，使开发人员能够轻松地了解和测试 API 的各种端点、参数和响应。

2. 在 Spring Boot 中整合 Swagger

在 Spring Boot 中，可以通过 Springfox（现在称为 Springdoc）来实现与 Swagger 的整合。以下是一个简单的示例，演示如何在 Spring Boot 中整合 Swagger：

首先，在 pom.xml 文件中添加 Springdoc 依赖：

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.6.3</version>
</dependency>

然后，在 Spring Boot 的启动类上添加 @EnableOpenApi 注解：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springdoc.core.GroupedOpenApi;
import org.springdoc.core.SwaggerUiConfigParameters;

@SpringBootApplication
public class SpringBootSwaggerApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringBootSwaggerApplication.class, args);
    }

    @Bean
    public GroupedOpenApi customApi() {
        return GroupedOpenApi.builder()
                .group("custom-api")
                .pathsToMatch("/api/**")
                .build();
    }
}

创建一个简单的 RESTful Controller：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ApiController {

    @GetMapping("/api/hello")
    public String hello() {
        return "Hello from API!";
    }
}