掌握SpringDoc枚举字段展示与SpringBoot枚举参数接收的秘诀，提升开发效率

2022-11-28 13:38:25

SpringDoc：让枚举字段在 API 文档中脱颖而出，SpringMVC：处理枚举参数的强大组合

简介

在构建基于 REST 的 API 时，处理枚举数据类型可能是一项具有挑战性的任务。SpringDoc 和 SpringMVC 是两个功能强大的框架，它们可以帮助您轻松地为 API 文档添加枚举字段的展示，并使应用程序能够接收枚举值作为参数。在这篇深入的博客中，我们将探讨如何使用 SpringDoc 和 SpringMVC 来简化枚举处理，提升您的 API 的可理解性和可维护性。

一、SpringDoc 配置：枚举字段展示

SpringDoc 是一个出色的工具，它可以帮助您自动生成 API 文档。要配置 SpringDoc 以展示枚举字段，请在您的项目中添加以下依赖项：

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

然后，您可以在 application.properties 文件中添加以下配置：

springdoc.paths-to-match=/api/**

通过这些配置，SpringDoc 将自动生成 API 文档，其中包含清晰展示的枚举字段。

二、SpringMVC 配置：接收枚举参数

要配置 SpringMVC 以接收枚举参数，请在您的项目中添加以下依赖项：

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>5.3.18</version>
</dependency>

在您的控制器中，您可以使用 @RequestParam 注解来接收枚举参数。例如：

@RequestMapping(value = "/api/test", method = RequestMethod.GET)
public ResponseEntity<String> test(@RequestParam MyEnum myEnum) {
    return ResponseEntity.ok("You selected: " + myEnum.name());
}

现在，您的应用程序可以无缝地接收和处理枚举参数。

三、示例代码

为了更好地理解 SpringDoc 和 SpringMVC 在枚举处理中的协作，我们提供了一个示例代码：

@SpringBootApplication
public class DemoApplication {

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

public enum MyEnum {
    A,
    B,
    C
}

@RestController
@RequestMapping("/api")
public class DemoController {

    @GetMapping("/test")
    public ResponseEntity<String> test(@RequestParam MyEnum myEnum) {
        return ResponseEntity.ok("You selected: " + myEnum.name());
    }
}