1. 程式人生 > 程式設計 >基於swagger測試List型別引數過程詳解

基於swagger測試List型別引數過程詳解

使用swagger 時,往往會用到類似下面這樣的註解

@ApiImplicitParam(name = "id",value = "主鍵",dataType = "int",paramType = "query")

網上說這裡的dataType 型別有String / int兩種,其餘的都是無用的。

但是如果需要傳遞的引數是List型別,應該怎麼辦?

首先直接在瀏覽器中輸入網址,傳遞引數(xxx?idList=1,2,3)來測試,是沒有問題的

在swagger中如果直接使用int,List<Integer> 這樣的引數,會導致swagger無法測試介面,如下:

@ApiImplicitParam(name = "idList",value = "id列表",required = true,paramType = "query")

後來我的一個複雜的做法是:把List的所有值傳一個String型別的引數,用中括號包起來,最後再解析。形如 xxx?idList=[1,3] ,可以實現效果,但是比較麻煩

再後來突然發現一個很簡單的解決辦法

那就是去掉@ApiImplicitParam 註解(注:我的swagger 版本是2.8.0,)

比如:

@ApiOperation("批量查詢課程資訊")

public Result listXxxByIdList(@RequestParam(value = "idList") List<Long> idList) {...}

這樣以後,測試的時候,就可以新增、刪除List引數了,這個引數的型別是array[],如下圖:

基於swagger測試List型別引數過程詳解

可能是因為後來的swagger版本能夠自動識別方法中的引數了,這樣做的缺點只是沒有中文描述而已

當然如果非要加上中文描述也是可以的,那就是使用 @ApiParam 註解,如下:

@ApiOperation("批量查詢課程資訊")

public Result listXxxByIdList(@RequestParam(value = "idList") @ApiParam(value = "id列表") List<Long> idList) {...}

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援我們。