java - 用于 MultivaluedMap Jersey 的 Swagger API？是否可以？

Question

是否可以通过 MultivaluedMap 的注解制作 API 文档？使用 Swagger 在 Jersey 中设置参数？

我有一段这样的代码:

/**
 * Method which serves requests of adding {@link StudentGroup} to DB
 * 
 * @param name
 * @param description
 * @return {@link Response}
 * @throws RestServiceException
 */
 @POST
 @Path("/add")
 public Response addStudentGroup(MultivaluedMap<String, String> formParams) throws 
     RestServiceException {
     String name = formParams.getFirst("name");
     String description = formParams.getFirst("description");
     String studentIds = formParams.getFirst("studentIds");

     (...)

}

我想使用 @ApiParam生成 JSON使用 Swagger 和 Swagger UI 的文档数据。

如果我输入 @ApiParam之前 MultivaluedMap<String, String> formParams 它不起作用。 Swagger 无法列出任何参数。

Answer 1

这似乎是 Swagger 中的一个错误 - 我也有这种行为。使用其他带有两个类型参数的泛型类(如@ApiParam() HashMap)效果很好。可能它会关闭解析器。

我打开了an issue for this在 Swagger bug tracking system 上.

你也可以问他们on their Google group或在 Freenode#swagger 的 IRC 上找到它们。