Springdoc-openapi -有没有办法覆盖POST请求中的默认值为null或empty？

Springdoc-openapi 是一个用于自动生成 OpenAPI 文档的库，它与 Spring Boot 应用程序集成良好。在处理 POST 请求时，有时你可能希望覆盖默认值为 null 或空字符串（empty），以确保 API 的行为符合预期。

基础概念

OpenAPI：一种描述 RESTful API 的标准格式，允许人和计算机无需访问源代码、文档或通过网络流量检查就能发现和理解服务的功能。

Springdoc-openapi：一个库，它简化了在 Spring Boot 应用程序中生成 OpenAPI 文档的过程。

类型与应用场景

类型：Springdoc-openapi 支持多种配置选项，包括路径参数、请求体、响应等。
应用场景：适用于任何需要自动生成和维护 API 文档的 Spring Boot 项目。

遇到的问题及解决方法

问题描述

默认情况下，如果 POST 请求中的某个字段未提供，Springdoc-openapi 可能会将其视为 null 或空字符串。有时，你可能希望为这些字段设置特定的默认值。

原因分析

这是由于 OpenAPI 规范和 Spring Boot 的默认行为所致。OpenAPI 允许字段为可选，并且未提供的字段通常会被视为 null 或空字符串。

解决方法

你可以通过自定义 @Schema 注解来覆盖默认行为。以下是一个示例：

import io.swagger.v3.oas.annotations.media.Schema;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    @PostMapping("/example")
    public void exampleMethod(@RequestBody ExampleRequest request) {
        // 处理请求
    }

    public static class ExampleRequest {
        @Schema(description = "字段描述", required = true, defaultValue = "默认值")
        private String myField;

        // Getter 和 Setter
        public String getMyField() {
            return myField;
        }

        public void setMyField(String myField) {
            this.myField = myField;
        }
    }
}

在这个示例中，@Schema 注解的 defaultValue 属性用于指定字段的默认值。这样，即使客户端未提供该字段，服务器端也会使用指定的默认值。

示例代码

import io.swagger.v3.oas.annotations.media.Schema;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    @PostMapping("/example")
    public void exampleMethod(@RequestBody ExampleRequest request) {
        // 处理请求
        System.out.println("Received value: " + request.getMyField());
    }

    public static class ExampleRequest {
        @Schema(description = "字段描述", required = true, defaultValue = "默认值")
        private String myField;

        // Getter 和 Setter
        public String getMyField() {
            return myField;
        }

        public void setMyField(String myField) {
            this.myField = myField;
        }
    }
}

通过这种方式，你可以确保即使客户端未提供某个字段，服务器端也会使用你指定的默认值，而不是 null 或空字符串。