使用Swagger2自動生成RestApi頁面文檔

Swagger2自動生成RestApi文檔

前言

目前RestApi很流行，歸根結底有兩個主要緣由：

一、在多終端普及的狀況下，RESTful風格Api的使用愈來愈頻繁；
二、隨着公司規模的擴大，先後端工程師的數量增長，如何才能在一個項目中更好地溝通？接口的定義和接口文檔的規範成了關鍵點，RESTful在其中扮演者重要角色。

REST定義着接口的規範，Swagger2生成接口文檔；
有了Swagger2，不用再去寫複雜的接口文檔，也不用擔憂接口的更新會致使文檔的報廢；
那麼如何掌握Swagger2呢？這就是該文章存在的意義。

本篇主要講解的就是如何在Spring Boot上使用Swagger2

第一步：添加maven依賴

須要添加兩個依賴，注意版本相同：

第二步：編寫Swagger2配置類

經過createRestApi()方法返回Docket，調用如下方法：
apiInfo()方法中能夠添加api文檔的基本信息（具體類型查看文檔）；
select()方法返回ApiSelectorBuilder實例，用於過濾哪些api須要顯示；
apis()方法中填寫項目中Controller類存放的路徑；
最後build()創建Docket。

第三步：添加文檔中的api和參數

如何在api文檔中選擇要顯示的api和對應參數，
咱們須要在具體api上加上註解：

以上面的login方法爲例：
@ApiOperation用來描述api；
@ApiImplicitParams定義多個參數（若是隻有一個參數能夠不用）；
@ApiImplicitParam用來描述傳入參數。

到這裏配置和注入已經完成，
接下來咱們進入http://localhost:8088/swagger-ui.html查看api文檔：

如圖所示，就是RESTful的api頁面文檔，在上面能夠點擊查看詳情。

注意點

在application.properties中的靜態資源路徑配置可能致使你沒法訪問；
可是有同窗就問了：不配置靜態資源路徑怎麼拿到靜態資源？
咱們看下swagger的包的所在路徑：

因此在配置好的spring靜態資源訪問路徑後加上,classpath:/META-INF/resources

如此這般，就能在先後端分離的狀況下使用swagger2了

以上即是Swagger2在Spring Boot上的應用；
以爲還能夠的請點個贊，贊不了也能夠收藏下；
總之，謝謝閱讀～