Swagger

不管是對內對外，提供介面的一方必須要有配套的API文檔。

我們公司以前在做Server端的時候，都是由開發人員編寫，現實情況大家都清楚，給你的開發時間恨不得壓縮再壓縮，哪有時間去寫文檔，更何況需求變來變去，介面變來變去，開發要快速響應，及時更新文檔的時間領導未必給，或者開發人員單純就犯懶了，導致介面文檔更新很不及時。

Swagger就是API文檔、測試的好工具。

工程構建

先構建一個Spring Boot工程，快遞單服務，有增刪改查獲取列表5個HTTP介面。

代碼結構如下：

代碼結構

Bo類：ExpressBo：int id，String fromAddr；String toAddr

Vo類：ExpressReq：String fromAddr；String toAddr

ExpressRes：int recode；String restr；List<ExpressBo>

Controller：

public ExpressRes exprGet(Integer id);

public ExpressRes exprsGet();

public ExpressRes exprPost(ExpressReq req);

public ExpressRes exprPut(ExpressReq req,Integer id);

public ExpressRes exprDel(Integer id);

application.yml：

application.yml

運行Spring Boot，使用Postman對5個方法進行測試，結果如下：

獲取列表

根據ID獲取詳情

新增

修改

刪除

Swagger配置

pom增加依賴：

pom.xml

新建Swagger2Config：

Swagger配置項

Value是寫在application.yml裡面的，還可以結合Spring Cloud Config。apiInfo這個方法里還能填充更多的信息。

swagger2Docket裡面還能做更多的配置，比如對時間類的轉換等等。具體大家參考官方文檔即可。

API配置

對類的配置：

實體類

請求類

響應類

對Controller的配置：

Controller

對方法的配置：

1

2

如果參數有多個，就要用@ApiImplicitParams包住@ApiImplicitParam

3

注意紅框的paramType，如果我們的參數是在url裡面，這個要設置成path。

結果

啟動工程，訪問http://localhost:4444/swagger-ui.html

介面API頁面

點擊進去，可以查看詳細的介面信息，還能進行測試（不用Postman啦）。具體API的註解項大家參看官方文檔即可。

喜歡這篇文章嗎？立刻分享出去讓更多人知道吧！