現在的網站架構基本上都是前後端分離，然後出現了前端工程師和後端工程師的崗位區分(當然你也可以是全棧的)。前端和後端的唯一聯絡，變成了API介面；API文件變成了前後端開發人員聯絡的紐帶，變得越來越重要

相信大多數朋友都遇到過上面的場景：明明呼叫的是之前約定好的API，拿到的結果卻不是想要的。可能因為是有人修改了API的介面，卻忘了更新文件；又或者是文件寫的有歧義，大家的理解各不相同。

一般軟體開發專案組都會有API文件，它是前後端開發人員配合工作的橋樑。常規文件的形式都是記錄在word或者是類似confluence的wiki伺服器上。但是這些形式都會出現上面的問題。讓API文件總是與API定義同步更新，是一件非常有價值的事。

Swagger 是一個規範和完整的框架，用於生成、描述、呼叫和視覺化RESTful風格的Web服務。Swagger作用：1. 線上自動生成排版優美的介面文件。2. 功能測試。

鑑於swagger的強大功能，Java開源界大牛spring框架迅速跟上，它充分利用自已的優勢，把swagger整合到自己的專案裡，整了一個spring-swagger，後來便演變成springfox。springfox本身只是利用自身的aop的特點，透過plug的方式把swagger集成了進來，它本身對業務api的生成，還是依靠swagger來實現。

maven依賴：

=>@EnableSwagger2註解,啟動Swagger支援，表示這是一個Spring Swagger的配置檔案

=>@Api表示這是一個需要Swagger表示的類寫在Controller的頭部

@ApiOperaction表示這是一個需要Swagger修飾的介面，其中表明瞭介面名稱，請求方式、備註說明等資訊。

@ApiImplicitParam表示該介面輸入的引數：name表示引數名稱；value表示引數說明；paramType表示傳入型別，請求頭傳入寫query,JSON型別傳入寫json；defaultValue表示預設值；required表示引數是否必須傳。

專案啟動後就可以直接用類似於以下的地址來檢視api列表了：http://127.0.0.1:8080/jadDemo/swagger-ui.html

是不是很不錯，try it！