2013-01-12 25 views
4

是否可以通过使用Swagger在泽西注册MultivaluedMap param来制作API文档?用于多值映射泽西岛的Swagger API?可能吗?

我有一个这样的一小段代码:

/** 
* 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使用扬鞭和扬鞭UI文档数据。

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

回答

2

看来这是Swagger中的一个错误 - 我也得到了这种行为。使用具有两个类型参数的其他泛型类(如@ApiParam()HashMap)可以正常工作。可能它会抛出解析器。

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

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

+0

该票证自2013年以来一直关闭为“不受支持”,这对于正确记录灵活的REST端点(如搜索方法)来说是个大问题。 :( – chrisinmtown

1

目前尚不支持,但正如Eyal所说,有一张票在github问题中打开,它可能相当容易实现。