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, dataType = "int", paramType = "query")


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

再后來突然發現一個很簡單的解決辦法
那就是去掉@ApiImplicitParam 注解(注:我的swagger 版本是2.8.0,)

比如:

@ApiOperation("批量查詢課程信息")

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

這樣以后,測試的時候,就可以添加、刪除List參數了,這個參數的類型是array[], 如下圖:

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

 

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

 @ApiOperation("批量查詢課程信息")

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

 

原創文章,歡迎轉載,轉載請注明出處!


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM