swagger ui with Jax Rs resource的collection(List)输入参数

时间:2014-08-08 02:59:01

标签: swagger swagger-ui

如何配置swaggerui以显示具有集合输入参数的JAX-RS资源的正确参数数据类型?

下面是一个groovy JAX-RS资源示例。其输入类型为List<User>

@POST
@Produces(APPLICATION_JSON)
@Consumes(APPLICATION_JSON)
@ApiOperation(value = "Create(s) users", response = User, responseContainer = "List")
Response createUsers(List<User> questions) {
}

在swagger UI中,我看到填充了空类型的列表而不是User。它适用于输出参数。使用ApiOperation注释,我可以指定响应类型。

@ApiOperation(value = "Create(s) users", response = User, responseContainer = "List")

对于输入参数,如何在swagger UI中查看用户模型模式列表? enter image description here

1 个答案:

答案 0 :(得分:4)

尝试在列表中使用@ApiParam:

@POST
@Produces(APPLICATION_JSON)
@Consumes(APPLICATION_JSON)
@ApiOperation(value = "Create(s) users", response = User, responseContainer = "List")
Response createUsers(@ApiParam("description") List<User> questions) {
}