1、 什么是Swagger
Swagger 是一個規范和完整的框架，用於生成、描述、調用和可視化RESTful風格的 Web 服務。總體目標是使客戶端和文件系統作為服務器以同樣的速度來更新。文件的方法，參數和模型緊密集成到服務器端的代碼，允許API來始終保持同步。Swagger讓部署管理和使用功能強大的API變得非常簡單。
Swagger采用Open API規范，Open API規范這類API定義語言能夠幫助你更簡單、快速的表述API，尤其是在API的設計階段作用特別突出。一旦編寫完成，API文檔可以作為：
· 需求和系統特性描述的根據
· 前后台查詢、討論、自測的基礎
· 部分或者全部代碼自動生成的根據
· 其他重要的作用，比如開放平台開發者的手冊
2、 如何編寫API文檔
1）、定義YAML文件，然后可以生成各種語言的代碼框架，對於后台程序員來說，較少人會願意寫出一堆YAML格式。
2）、定義JSON格式文件，按照swagger文檔書寫規范編寫文檔，和YAML一樣只是兩種不同格式。
3）、通過swagger的各種語言的插件，可以通過配置及少量代碼，生成接口文檔及測試界面。通過yaml或json書寫的是靜態文檔，完成后可以通過可視化頁面顯示接口文檔。但要完成整個項目的接口文檔書寫也非常耗時，如果是后台開發，可以通過簡單配置實現文檔的自動生成。
3、Swagger在API項目中的應用
Eolinker是我們公司內部用的一個集成化的接口管理工具，包含開發、測試和文檔的功能，打包好的架構也少了很多代碼輸入的工作。下面用它來演示一下和Swagger的對接。
網址：www.eolilnker.comhttps://datayi.cn/w/nomk4MvR
1）、在Eolinker界面直接導入json格式的Swagger文件；
2）、直接對寫好的接口進行測試；
可以直接在詳情里修改單獨某個接口的參數，且接口文檔的內容是跟隨接口改動實時變化的。相對於靜態的文檔每次改動都需要開發更新文檔，這無疑是非常好的解決方案。
3）、可以導出多種格式的文檔；
有時候對外的項目對接，對方不是用的Swagger，也可以導出成其他格式的文檔，這個是我比較驚喜的點。