2013-01-12 48 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問題中打開,它可能相當容易實現。