資料
Swagger API接口管理
介紹
Swagger API框架,用於管理項目中API接口,屬當前最流行的API接口管理工具。 Swagger功能強大,UI界面漂亮,支持在線測試等!
Swagger包括庫、編輯器、代碼生成器等很多部分,Swagger UI是一個API在線文檔查看和測試的利器,Swagger Editor主要是編寫api接口文檔,但需要配合Swagger UI來展示,使用yaml編寫。
國內開發者也有提供一整套開源的解決方案sosoapi,基於swagger的實現的,操作簡單方便。可以導出swagger文件或者PostMan文件等。sosoapi是基於json文檔的形式整合swagger,提供在線表單編輯對應的json格式文檔及相關的一些團隊協助功能,如團隊成員管理,權限控制,導出html/word,編輯日誌,複製項目/接口,mock服務。表單形式的編輯方式大大降低了集成swagger的學習成本,使得團隊能快速上手。界面的展示也是使用原生的Swagger UI。
1. Swagger
Swagger Editor
Github項目 下載項目並解壓並放入http容器/web容器(如tomcat等)訪問目錄名既可。(不知道爲什麼官網下載的一直不可以使用,後面到csdn下載一個就可以使用。百度網盤地址:http://pan.baidu.com/s/1geRhBSv 【swagger-editor.zip】)
Swagger UI
Github主頁 下載源碼,將dist目錄訪放入http容器/web容器(如tomcat等)即可通過目錄名“dist”訪問。
2. SosoApi
本地:只需要到 sosoapi Github項目地址 下載項目,並將dist目錄下war包即可部署到tomcat既可使用和在線一樣的功能。
Eclipse部署源碼
到 sosoapi Github項目地址 下載項目(web和framwork),並將項目部署到Eclipse,修改部分pom,並將framwork裏面的項目都分別導入到Eclipse,項目結構如圖:
即可部署sosoapi-web到web容器如tomcat等,調通的Eclipse項目下載:鏈接:http://pan.baidu.com/s/1o7Zbpqy 密碼:iapf,其他具體項目配置參考項目目錄下的doc的文檔。
1. Swagger
通過Swagger Editor編寫基於YAML語法定義的RESTful API,然後它會自動生成一篇排版優美的API文檔,並且提供實時預覽。並且可以生產客戶端和服務器的接口定義的代碼。
編輯完,下載json文件“swagger.json”
將json文件導入Swagger UI中,在Swagger UI項目根目錄下修改index.html文件
訪問Swagger UI主頁即可看到更新的api
Swagger 集成代碼的用法
Swagger 可以和Spring MVC或Spring Boot 整合,通過註解自動生成Swagger 文檔。
資料
1. 官網 http://swagger.io/
2. 相關文檔 http://swagger.io/docs/
3. http://www.cnblogs.com/whitewolf/p/4686154.html 【Swagger - 前後端分離後的契約-破狼】
4. http://www.sosoapi.com/ 【swagger-ui 國內在線的擴展版】
5. http://bbs.sosoapi.com/forum.php?mod=viewthread&tid=220#lastpost 【SosoApi和Swagger有什麼關聯?】
6. http://www.2cto.com/kf/201604/499072.html 【Swagger使用】
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.