今天有同事用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è)參考，也希望大家多多支持腳本之家。

最新評(píng)論