使用Swagger注释来记录数组类型

Question

我有一个资源接受具有数组类型的JSON主体的POST请求，例如：

[
  { "foo": "bar" },
  { "foo": "baz" },
  ...
]

要使用Swagger注释记录非收集类型，我可以这样做：

@ApiImplicitParams(Array(
  new ApiImplicitParam(paramType = "body", dataType = "my.Request", required = true)
))

如何对阵列体类型执行相同操作，例如Seq[my.Request]？

Answer 1

可以通过引入扩展Java标准库列表的代理特征来完成：

trait ArrayBody extends java.util.List[ArrayElementType]

然后在端点注释中：

@ApiImplicitParams(Array(
  new ApiImplicitParam(paramType = "body", dataType = "foo.bar.ArrayBody", required = true)
))