如何使用SpringDoc-OpenAPI使可选的OpenAPI参数为空？

Question

springdoc-openapi库自动标记生成的OpenAPI文档中所需的某些属性。例如，注释为@notnull的属性将包括在生成的YAML文件中所需的属性列表中。

库不做的一件事是将可选属性标记为nullable:true。但是，默认情况下，Spring Boot应用程序将在请求中接受null，并在可选属性的响应中返回null。这意味着OpenAPI文档和endpoint行为之间存在差异。

在SpringDoc-OpenAPI生成的OpenAPI文档中，如何将可选属性标记为nullable:true？

import io.swagger.v3.oas.annotations.media.Schema;
import javax.validation.constraints.NotNull;

public class RequiredExample {
    @NotNull
    private String key;

    private String value;

    public String getKey() { return key; }
    public void setKey(String key) { this.key = key; }
    public String getValue() { return value; }
    public void setValue(String value) { this.value = value; }
}

"components": {
  "schemas": {
    "RequiredExample": {
      "required": [
        "key"
      ],
      "type": "object",
      "properties": {
        "key": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    }
  }
}

"components": {
  "schemas": {
    "RequiredExample": {
      "required": [
        "key"
      ],
      "type": "object",
      "properties": {
        "key": {
          "type": "string"
        },
        "value": {
          "type": "string"
          "nullable": true
        }
      }
    }
  }
}

Answer 1

一个解决方案是创建一个springdoc-openapiOpenAPICUSTOMISERSpring bean，它将所有属性设置为nullable，除非它们在required属性列表中。这种方法得益于内置的springdoc-openapi对@Notnull和其他此类注释的支持，因为required属性将根据这些属性的存在以标准方式计算。

java prettyprint-override">import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.media.Schema;
import org.springdoc.core.customizers.OpenApiCustomiser;
import org.springframework.stereotype.Component;
import java.util.Map;

@Component
public class NullableIfNotRequiredOpenApiCustomizer implements OpenApiCustomiser {
    @Override
    @SuppressWarnings({"rawtypes", "unchecked"})
    public void customise(OpenAPI openApi) {
        for (Schema schema : openApi.getComponents().getSchemas().values()) {
            if (schema.getProperties() == null) {
                continue;
            }

            ((Map<String, Schema>) schema.getProperties()).forEach((String name, Schema value) -> {
                if (schema.getRequired() == null || !schema.getRequired().contains(name)) {
                    value.setNullable(true);
                }
            });
        }
    }
}