大摇大摆的UI，SpringDoc，OpenAPI 3.0:PostBody而不是textarea的UI字段？

Question

• SpringDoc 1.5.3（最新版本）
• SwaggerUI 3.41.0（最新版本）

Swagger UI显示了@recestParam的好字段。

我有一个POSTendpoint，所以我使用了@ask estBody。
我可以发送一个JSON，它解析成我的bodyhtml" target="_blank">对象。到目前为止还不错。

但是，Swagger UI只显示一个文本区域，我应该在其中放置整个JSON。这不太方便。

我希望Swagger UI为请求类的每个属性显示单独的字段；没有YAML，就有注释。尽管如此，如果没有其他选择，YAML解决方案也可以。

我找到的最接近的是对POST的@ParameterObject支持，这里讨论过：

class MyParam (
    val a: String,
    val b: SomeEnum,
    @field:Parameter(required = false)
    val someId: String?,
)

@PostMapping("/...", consumes = [ MediaType.APPLICATION_JSON_VALUE ])
fun addMyEntity(
      @ParameterObject param: MyParam
)

但是，这似乎是从查询参数构建对象。

在SpringFox中，曾经有@ApiModel和@ApiModelParameter，我想这会实现。SpringDoc迁移页面建议将其替换为@Schema，但我不知道该怎么做。

有没有什么东西可以让Swagger UI以同样的方式显示类中的字段，但是从中组装一个JSON主体？Spring仍然会从身体中解析它？

也许是这样的：

fun addInsisPaymentRequest(
      @BodyObject param: MyParam
)

Answer 1

我怀疑你提议的解决方案的可行性。原因是，POST/PUT请求接受一个请求主体，正如您所知，该请求主体可以接受任何有效的有效负载。

有效负载的范围可以从基本类型到应用程序使用的自定义对象。此外，数据类型不仅限于JSON，还可以是XML、HAL等。

此外，值得注意的一点是，任何有效的Json/Xml都可以具有递归对象。考虑下面的例子。

{
  "prop1": "val1",       // 1st order element
  "prop2": {             // 1st order element
    "sub-prop1": "val2", // 2nd order element
    "sub-prop2": [       // 2nd order element
      "val3",
      "val4"
    ]
  }

现在出现的问题是，您可以为所有这些参数提供类似于查询参数的表示，但是您将如何表示它们应该出现的顺序？

就@ParameterObjects而言，它们大多是基元类型。虽然将它们作为复杂类型并非不可能，但我认为我们中的很多人并不经常这样做。