解決Swagger2返回map復(fù)雜結(jié)構(gòu)不能解析的問(wèn)題
今天有同事用swagger2開(kāi)發(fā)時(shí),有一方法返回Map<String,List<Object>>出現(xiàn)無(wú)法解析錯(cuò)誤。
Pom.xml引入的swagger版本如下:
<!--swagger start--> <dependency> <groupId>io.swagger</groupId> <artifactId>swagger-annotations</artifactId> <version>1.5.20</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.6.1</version> </dependency> <!--swagger end-->
具體原因:
swaggerconfig沒(méi)有默認(rèn)添加map的復(fù)雜結(jié)構(gòu)引起的,需要手動(dòng)添加。
步驟:
1. 找到swaggerconfig類,在Docket方法里添加一些mapRule即可
2. 這里設(shè)計(jì)rule比較靈活,我就按標(biāo)題的格式添加,其中Model.class是自定義的業(yè)務(wù)類,換成自己的即可。
docket.alternateTypeRules(AlternateTypeRules.newMapRule(String.class, List.class)); docket.alternateTypeRules(AlternateTypeRules.newMapRule(List.class, Model.class));
具體代碼如下:
@Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket createRestApi() { Docket docket = new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) .paths(PathSelectors.any()) .build(); docket.alternateTypeRules(AlternateTypeRules.newMapRule(String.class, List.class)); docket.alternateTypeRules(AlternateTypeRules.newMapRule(List.class, Model.class)); return docket; } }
Swagger使用過(guò)程中遇到的坑
1、無(wú)限請(qǐng)求
如果swagger頁(yè)面請(qǐng)求有錯(cuò)誤,swagger會(huì)無(wú)限嘗試訪問(wèn),后面重啟項(xiàng)目的時(shí)候,控制層會(huì)無(wú)限刷新出現(xiàn)日志的內(nèi)容
本地的好辦,如果項(xiàng)目項(xiàng)目部署到服務(wù)器中,可能十幾分鐘產(chǎn)生幾個(gè)G的日志文件
解決方式:最簡(jiǎn)單的方式——關(guān)閉請(qǐng)求報(bào)錯(cuò)的瀏覽器
2、同名問(wèn)題
@Api(同名的問(wèn)題) 因?yàn)閟wagger會(huì)根據(jù)tags 的名稱查找對(duì)象,有同名對(duì)象的時(shí)候,swagger的文檔就會(huì)出現(xiàn)問(wèn)題
如果swagger的某個(gè)API下出現(xiàn)不屬于該API的請(qǐng)求,這個(gè)就是API的同名的問(wèn)題,查找相同的API名稱替換即可
3、類上的注解“/”的問(wèn)題
@ApiModel(不能使用“/”)
Errors
Hide
Resolver error at paths./v1-0/Configuration/add.post.parameters.1.schema.properties.listHotCarBrandIVO.items.$ref
Could not resolve reference because of: Could not resolve pointer: /definitions/熱門車/品牌/的IVO does not exist in document
4、使用map作為返回類型報(bào)錯(cuò),
Errors
Hide
Resolver error at definitions.Map«string,List«賣車車輛信息OVO»».additionalProperties.$ref
Could not resolve reference because of: Could not resolve pointer: /definitions/List does not exist in document
兩個(gè)解決方案:升級(jí)swagger版本號(hào),這個(gè)是我用2.8.0報(bào)錯(cuò)會(huì)報(bào)錯(cuò),網(wǎng)上有說(shuō)升級(jí)版本可以解決,這個(gè)我沒(méi)有去試,
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.8.0</version> </dependency>
我這邊的解決方案是,將map定義在對(duì)象中,面向?qū)ο缶幊?,而且這樣生成文檔的時(shí)候,注釋也會(huì)顯示好
5、swagger版本的問(wèn)題,2.8之前的版本在 路徑/{id} +@pathVarisble 這樣的寫(xiě)法
2.8之前,swagger給出的類型居然是body,需要用json的格式傳這個(gè)很奇怪,
版本更新到2.8以后,路徑后面綁定的參數(shù)就是 swagger給出的類型居然是就能是param
適當(dāng)?shù)母掳姹居泻锰?/p>
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.8.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.8.0</version> </dependency>
6、沒(méi)有重現(xiàn)過(guò)的一個(gè)bug
Failed to execute 'fetch' on 'Window': Failed to parse URL from http://localhost/8765undefindFailed to parse URL from http://localhost/8765undefind
我一直重啟項(xiàng)目 swagger沒(méi)有重現(xiàn)問(wèn)題
后來(lái)我修改請(qǐng)求你方法上的api注釋,重啟就可以,可能是swagger上api沖突,關(guān)鍵是這個(gè)沒(méi)有提示,好暈;如果誰(shuí)找到重現(xiàn)這個(gè)問(wèn)題來(lái)說(shuō)一下
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
springboot2.0整合logback日志的詳細(xì)代碼
這篇文章主要介紹了springboot2.0整合logback日志的應(yīng)用場(chǎng)景分析,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-02-02Java 數(shù)組分析及簡(jiǎn)單實(shí)例
這篇文章主要介紹了Java 數(shù)組分析及簡(jiǎn)單實(shí)例的相關(guān)資料,在Java中它就是對(duì)象,一個(gè)比較特殊的對(duì)象,需要的朋友可以參考下2017-03-03IDEA關(guān)于.properties資源文件的編碼調(diào)整問(wèn)題
這篇文章主要介紹了IDEA關(guān)于.properties資源文件的編碼調(diào)整問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-06-06一問(wèn)詳解SpringBoot配置文件優(yōu)先級(jí)
在SpringBoot項(xiàng)目當(dāng)中,我們要想配置一個(gè)屬性,可以通過(guò)這三種方式當(dāng)中的任意一種來(lái)配置都可以,那么優(yōu)先級(jí)怎么算,本文主要介紹了一問(wèn)詳解SpringBoot配置文件優(yōu)先級(jí),需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-04-04java實(shí)現(xiàn)電腦定時(shí)關(guān)機(jī)的方法
這篇文章主要介紹了java實(shí)現(xiàn)電腦定時(shí)關(guān)機(jī)的方法,首先通過(guò)java注冊(cè)windows服務(wù)程序,再以一個(gè)簡(jiǎn)單的java程序?qū)崿F(xiàn)定時(shí)關(guān)機(jī)的功能,非常具有實(shí)用價(jià)值,需要的朋友可以參考下2014-11-11基于Spring Boot應(yīng)用ApplicationEvent案例場(chǎng)景
這篇文章主要介紹了基于Spring Boot應(yīng)用ApplicationEvent,利用Spring的機(jī)制發(fā)布ApplicationEvent和監(jiān)聽(tīng)ApplicationEvent,需要的朋友可以參考下2023-03-03SpringBoot整合MQTT并實(shí)現(xiàn)異步線程調(diào)用的問(wèn)題
這篇文章主要介紹了基于SpringBoot通過(guò)注解實(shí)現(xiàn)對(duì)mqtt消息處理的異步調(diào)用,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-11-11