基于swagger測(cè)試List類型參數(shù)過程詳解
使用swagger 時(shí)，往往會(huì)用到類似下面這樣的注解
@ApiImplicitParam(name = "id", value = "主鍵", dataType = "int", paramType = "query")
網(wǎng)上說這里的dataType 類型有String / int兩種，其余的都是無用的。
但是如果需要傳遞的參數(shù)是List類型，應(yīng)該怎么辦?
首先直接在瀏覽器中輸入網(wǎng)址，傳遞參數(shù)（xxx?idList=1,2,3）來測(cè)試，是沒有問題的
在swagger中如果直接使用int，List<Integer> 這樣的參數(shù)，會(huì)導(dǎo)致swagger無法測(cè)試接口，如下：
@ApiImplicitParam(name = "idList", value = "id列表", required = true, dataType = "int", paramType = "query")
后來我的一個(gè)復(fù)雜的做法是：把List的所有值傳一個(gè)String類型的參數(shù)，用中括號(hào)包起來，最后再解析。形如 xxx?idList=[1,2,3] ，可以實(shí)現(xiàn)效果，但是比較麻煩
再后來突然發(fā)現(xiàn)一個(gè)很簡(jiǎn)單的解決辦法
那就是去掉@ApiImplicitParam 注解（注：我的swagger 版本是2.8.0，）
比如：
@ApiOperation("批量查詢課程信息")
public Result listXxxByIdList(@RequestParam(value = "idList") List<Long> idList) {...}
這樣以后，測(cè)試的時(shí)候，就可以添加、刪除List參數(shù)了，這個(gè)參數(shù)的類型是array[], 如下圖：
可能是因?yàn)楹髞淼膕wagger版本能夠自動(dòng)識(shí)別方法中的參數(shù)了，這樣做的缺點(diǎn)只是沒有中文描述而已
當(dāng)然如果非要加上中文描述也是可以的，那就是使用 @ApiParam 注解，如下：
@ApiOperation("批量查詢課程信息")
public Result listXxxByIdList(@RequestParam(value = "idList") @ApiParam(value = "id列表") List<Long> idList) {...}
以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要介紹了Java中如何使用stream流，文章圍繞Stream?API支持的許多操作展開主題，感興趣的小伙伴可以參考一下2022-09-09
SpringSecurity整合springBoot、redis實(shí)現(xiàn)登錄互踢功能
這篇文章主要介紹了SpringSecurity整合springBoot、redis實(shí)現(xiàn)登錄互踢,本文通過實(shí)例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2021-05-05
本文主要介紹了使用Maven快速生成SpringBoot項(xiàng)目打包文件的方法,包括如何生成可執(zhí)行的JAR文件,如何將配置文件、運(yùn)行腳本、調(diào)試腳本、證書文件等拷貝到指定目錄,及如何編譯出部署包,這種方法能大大方便微服務(wù)的部署,提高部署效率2024-10-10
這篇文章主要介紹了SpringBoot 2 統(tǒng)一異常處理過程解析,文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-09-09
Java的List集合框架之LinkedList詳細(xì)解析
這篇文章主要介紹了Java的List集合框架之LinkedList詳細(xì)解析,LinkedList底層是內(nèi)部Node類的存儲(chǔ),prev、next、item值,同時(shí)最外層還有first、last節(jié)點(diǎn),需要的朋友可以參考下2023-11-11
SpringBoot中的自定義FailureAnalyzer詳解
這篇文章主要介紹了SpringBoot中的自定義FailureAnalyzer詳解,FailureAnalyzer是一種很好的方式在啟動(dòng)時(shí)攔截異常并將其轉(zhuǎn)換為易讀的消息,并將其包含在FailureAnalysis中, Spring Boot為應(yīng)用程序上下文相關(guān)異常、JSR-303驗(yàn)證等提供了此類分析器,需要的朋友可以參考下2023-12-12
這篇文章主要介紹了java文件操作中的java寫文件示例,需要的朋友可以參考下2014-03-03
本文給大家介紹Go并發(fā)編程中使用channel的方法，通過實(shí)例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友參考下吧2021-11-11
這篇文章主要介紹了SpringData JPA 如何搭建 xml的配置方式,本文通過實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友參考下吧2023-12-12
這篇文章主要介紹了java實(shí)現(xiàn)Api接口加密通信方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2023-06-06