基于swagger測(cè)試List類型參數(shù)過(guò)程詳解
使用swagger 時(shí)，往往會(huì)用到類似下面這樣的注解
@ApiImplicitParam(name = "id", value = "主鍵", dataType = "int", paramType = "query")
網(wǎng)上說(shuō)這里的dataType 類型有String / int兩種，其余的都是無(wú)用的。
但是如果需要傳遞的參數(shù)是List類型，應(yīng)該怎么辦?
首先直接在瀏覽器中輸入網(wǎng)址，傳遞參數(shù)（xxx?idList=1,2,3）來(lái)測(cè)試，是沒(méi)有問(wèn)題的
在swagger中如果直接使用int，List<Integer> 這樣的參數(shù)，會(huì)導(dǎo)致swagger無(wú)法測(cè)試接口，如下：
@ApiImplicitParam(name = "idList", value = "id列表", required = true, dataType = "int", paramType = "query")
后來(lái)我的一個(gè)復(fù)雜的做法是：把List的所有值傳一個(gè)String類型的參數(shù)，用中括號(hào)包起來(lái)，最后再解析。形如 xxx?idList=[1,2,3] ，可以實(shí)現(xiàn)效果，但是比較麻煩
再后來(lái)突然發(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)楹髞?lái)的swagger版本能夠自動(dòng)識(shí)別方法中的參數(shù)了，這樣做的缺點(diǎn)只是沒(méi)有中文描述而已
當(dāng)然如果非要加上中文描述也是可以的，那就是使用 @ApiParam 注解，如下：
@ApiOperation("批量查詢課程信息")
public Result listXxxByIdList(@RequestParam(value = "idList") @ApiParam(value = "id列表") List<Long> idList) {...}
以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要介紹了Lombok注解-@SneakyThrows的使用，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-08-08
Java 開(kāi)發(fā)的幾個(gè)注意點(diǎn)總結(jié)
這篇文章主要介紹了Java開(kāi)發(fā)的幾個(gè)注意點(diǎn)的相關(guān)資料,需要的朋友可以參考下2016-09-09
這篇文章主要介紹了IDEA中如何引入spring的命名空間問(wèn)題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2023-04-04
大家都知道spring有多重配置方式，基于XML，基于注解，基于java類的配置，其中基于XML是最強(qiáng)大的一種，下面這篇文章主要給大家介紹了關(guān)于Spring裝配Bean之XML安裝配置bean的相關(guān)資料，需要的朋友可以參考借鑒，下面來(lái)一起看看吧。2017-10-10
JAVA得到數(shù)組中最大值和最小值的簡(jiǎn)單實(shí)例
這篇文章主要介紹了JAVA得到數(shù)組中最大值和最小值的簡(jiǎn)單實(shí)例,需要的朋友可以參考下2014-08-08
SpringBoot集成PostgreSQL并設(shè)置最大連接數(shù)
本文主要介紹了SpringBoot集成PostgreSQL并設(shè)置最大連接數(shù),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-11-11
Java利用位運(yùn)算實(shí)現(xiàn)乘法運(yùn)算詳解
這篇文章主要為大家詳細(xì)介紹了Java如何用位運(yùn)算實(shí)現(xiàn)乘法運(yùn)算，在實(shí)現(xiàn)乘法時(shí)要用位運(yùn)算實(shí)現(xiàn)，并且不能出現(xiàn)加減乘除任何符號(hào),感興趣的可以了解一下2023-04-04
java實(shí)現(xiàn)微信企業(yè)付款到個(gè)人功能
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)微信企業(yè)付款到個(gè)人功能，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2018-09-09
這篇文章主要介紹了詳解SpringMVC從基礎(chǔ)到源碼，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-09-09
Java中使用Lambda表達(dá)式和函數(shù)編程示例
這篇文章介紹了Java中使用Lambda表達(dá)式和函數(shù)編程示例，該文章會(huì)演示多個(gè)示列，分別是變量聲明上下文中的lambda、return語(yǔ)句上下文中的lambda、賦值上下文中的lambda、lambda在數(shù)組初始值設(shè)定項(xiàng)上下文中的用法等等,需要的朋友可以參考一下2021-10-10