自動生成接口文檔工具-Swagger的使用

出發點

接口文檔，方便明確接口名稱、參數和類型，能提升開發效率，也方便往後查看和肯定某個功能的接口。

咱們想找一個工具，方便前端查看接口文檔，也方便後端自動生成接口文檔。發現swagger有這方面的功能。下面是swagger的使用介紹，和與其餘工具的對比。

swagger簡介

在後端項目中引入Springfox-swagger，能夠掃描相關的代碼，生成一個描述文件，進而生成與代碼一致的接口文檔和客戶端代碼。這種經過代碼生成接口文檔的方式，在後面需求持續迭代的項目中，顯得很高效。

swagger特色

l 根據接口註釋，自動生成接口文檔（經過瀏覽器訪問）。

l 在線測試接口。

前端怎麼用swagger

請訪問示例連接：http://ip地址:端口號/項目名稱/swagger-ui.html

l 查看接口名稱

l 在Parameters查看請求參數

l 在Example Value查看返回參數

l 測試接口，輸入請求參數，點擊「Try it out!」

後端怎麼用swagger

l 定義接口名稱：使用@ApiOperation()和@RequestMapping()標註

l 定義請求參數：使用@RequestBody @ApiParam()標註

l 定義返回參數：使用@ResponseBody標註

l 定義數據模型：使用@ApiModel()標註

不一樣的項目怎麼訪問swagger

訪問路徑：http://ip地址:端口號/項目名稱/swagger-ui.html。因此多個項目，會有多個訪問路徑。