基于swagger測試List類型參數(shù)過程詳解
使用swagger 時,往往會用到類似下面這樣的注解
@ApiImplicitParam(name = "id", value = "主鍵", dataType = "int", paramType = "query")
網(wǎng)上說這里的dataType 類型有String / int兩種,其余的都是無用的。
但是如果需要傳遞的參數(shù)是List類型,應該怎么辦?
首先直接在瀏覽器中輸入網(wǎng)址,傳遞參數(shù)(xxx?idList=1,2,3)來測試,是沒有問題的
在swagger中如果直接使用int,List<Integer> 這樣的參數(shù),會導致swagger無法測試接口,如下:
@ApiImplicitParam(name = "idList", value = "id列表", required = true, dataType = "int", paramType = "query")
后來我的一個復雜的做法是:把List的所有值傳一個String類型的參數(shù),用中括號包起來,最后再解析。形如 xxx?idList=[1,2,3] ,可以實現(xiàn)效果,但是比較麻煩
再后來突然發(fā)現(xiàn)一個很簡單的解決辦法
那就是去掉@ApiImplicitParam 注解(注:我的swagger 版本是2.8.0,)
比如:
@ApiOperation("批量查詢課程信息")
public Result listXxxByIdList(@RequestParam(value = "idList") List<Long> idList) {...}
這樣以后,測試的時候,就可以添加、刪除List參數(shù)了,這個參數(shù)的類型是array[], 如下圖:
可能是因為后來的swagger版本能夠自動識別方法中的參數(shù)了,這樣做的缺點只是沒有中文描述而已
當然如果非要加上中文描述也是可以的,那就是使用 @ApiParam 注解,如下:
@ApiOperation("批量查詢課程信息")
public Result listXxxByIdList(@RequestParam(value = "idList") @ApiParam(value = "id列表") List<Long> idList) {...}
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持腳本之家。
相關文章
SpringSecurity整合springBoot、redis實現(xiàn)登錄互踢功能
這篇文章主要介紹了SpringSecurity整合springBoot、redis實現(xiàn)登錄互踢,本文通過實例代碼給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2021-05-05SpringBoot中的自定義FailureAnalyzer詳解
這篇文章主要介紹了SpringBoot中的自定義FailureAnalyzer詳解,FailureAnalyzer是一種很好的方式在啟動時攔截異常并將其轉換為易讀的消息,并將其包含在FailureAnalysis中, Spring Boot為應用程序上下文相關異常、JSR-303驗證等提供了此類分析器,需要的朋友可以參考下2023-12-12