目錄：

1，Spring Boot集成Swagger

2，Swagger接口文檔頁面

3，常見問題和解決方法

在Sping開發(fā)REST接口服務(wù)時，API文檔是不可缺少的一個重要部分。Swagger框架定義了完整的REST接口文檔規(guī)范，提供了強大的頁面測試功能，能夠調(diào)試和可視化API接口服務(wù)，并且將文檔融合到代碼中，讓維護文檔和修改代碼整合為一體，使得修改代碼邏輯的同時方便的修改文檔說明。

Spring集成Swagger只需3步配置，就能在線生成接口文檔，調(diào)試API功能。

代碼下載：https://github.com/jextop/StarterApi/

一，Spring Boot集成Swagger

1. 在pom.xml中添加Swagger依賴

2. 添加SwaggerConfig.java，配置文檔信息和掃描包路徑

3. (可選)代碼中引用Swagger注解，增加接口文檔。

- 不添加這些注解時，Swagger自動生成在線文檔將使用默認信息。

- 修改代碼功能邏輯時，同時維護文檔信息。

二，啟動項目，打開文檔頁面

1. http://localhost:8011/swagger-ui.html

2. 展開API信息，點擊按鈕”Try it out!”，調(diào)試接口功能。

三，常見問題和解決方法

l 增加@Api(tags={“xxx中文”})，Swagger文檔頁面中點擊接口名稱無法展開詳情？

解決：在pom.xml中配置maven依賴使用Swagger2.7.0或以后版本

原因：Swagger2.7.0修復(fù)了tags對中文的支持

總結(jié)

以上是生活随笔為你收集整理的swagger 修改dto注解_Web服务开发：Spring集成Swagger，3步自动生成API文档的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。