java - 如何记录提供另一种类型（MyClass 与 String）的 Rest 参数？

Question

在 Springfox 中，我曾经使用以下语法来渲染具有完整模型的 String 参数（原始 Github 问题）：

@PatchMapping(path="/{objId}")
@ApiImplicitParams(@ApiImplicitParam(name="update", dataType="MyClass")) 
    public ApiResponse<MyClass> updateMyClassInst(@PathVariable String objId, @RequestBody String update) {

这种表述的原因是，如果我将MyClass请求正文的类型作为类型，我无法区分属性何时未更新或何时设置为 null，因为两者都将被反序列化为 null 字段值。

我如何使用 Springdoc 做到这一点？

Answer 1

这是使用 OpenAPI 3 的等效代码。

@PatchMapping(path="/{objId}")
@RequestBody( content = @Content(schema = @Schema(implementation = MyClass.class)))
public ApiResponse<MyClass> updateMyClassInst(@PathVariable String objId, @RequestBody String update) {
    return null;
}

您可以查看 hte 迁移指南：

• https://springdoc.org/migrating-from-springfox.html

和招摇的文档：

• https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---注解