Swagger API介面管理
阿新 • • 發佈:2019-02-12
介紹 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。 Swagger 環境搭建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主頁即可看到更新的apiSwagger 整合程式碼的用法 Swagger 可以和Spring MVC或Spring Boot 整合,通過註解自動生成Swagger 文件。2. SosoApi
參考幫助文件使用即可。 主要功能如下: 最終效果 點選“測試”效果總結 如果使用Swagger的話使用sosoapi較為方便而且操作簡單。
資料
2. SosoApi
本地:只需要到 sosoapi Github專案地址
通過Swagger Editor編寫基於YAML語法定義的RESTful API,然後它會自動生成一篇排版優美的API文件,並且提供實時預覽。並且可以生產客戶端和伺服器的介面定義的程式碼。 編輯完,下載json檔案“swagger.json” 將json檔案匯入Swagger UI中,在Swagger UI專案根目錄下修改index.html檔案
參考幫助文件使用即可。 主要功能如下: 最終效果 點選“測試”效果總結 如果使用Swagger的話使用sosoapi較為方便而且操作簡單。
資料