Swagger中@API tags中含有中文異常問題的解決

Posted on by

Swagger @API tags中含有中文異常

最近在接觸新項目中用到瞭swagger，之前公司同事不喜好使用swagger也沒有在意。我個人比較偏好swagger 文檔開發，喜歡使用中文在標註各個接口。

重點

當前項目使用的是 swagger2     2.6.1  版本，這個版本有一個異常的地方：

在@API 註解中的 tags 包含中文後會導致界面UI接口方法不能正常伸縮，必須點擊外層的  Expand Operations 才能正常使用

解決方法

這裡使用的解決方法比較粗暴，升級swagger 版本  更新至 2.9.2，工程中引入更高級的swagger版本信息。

在引入後，記得打開瀏覽器，清除瀏覽器緩存。   

google 為例：

更新後的新版本界面，沒有 Expand Operations這個一個按鍵瞭

Swagger註解@Api(tags={中文})無法點擊展開

升級swagger依賴為2.9.2+

<dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger2</artifactId>
       <version>2.9.2</version>
    </dependency>
    
    <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger-ui</artifactId>
       <version>2.9.2</version>
    </dependency>

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：