Swagger簡介 4
安裝4
一睛蛛、Node.js安裝4
二、node中http-server安裝4
三忆肾、下載swagger-editor 4
四、啟動swagger-editor 5
五客冈、使用瀏覽器訪問http://localhost 5
使用5
一、編寫API文檔:7
二和悦、生成服務端代碼:8
三、修改&運行服務端:9
四鸽素、創(chuàng)建&運行客戶端:11
1.?使用swagger-editor的web界面:11
2.?使用swagger-editor生成的客戶端代碼14
3.?使用chrome的postman插件15
Swagger簡介
Swagger包括Swagger Editor,Swagger UI等很多部分馍忽,這里我們主要講一下Swagger Editor。它是一個完全開源的項目坝冕,并且它也是一個基于Angular的成功案例。
在Swagger Editor中喂窟,我們可以基于YAML等語法定義我們的RESTful API吵血,然后它會自動生成一篇排版優(yōu)美的API文檔,并且提供實時預覽蹋辅。簡單說就是可以邊編寫API 邊預覽邊測試。
在Swagger UI中侦另,我們不能進行編寫API ,但是我們可以預覽或者測試弃锐。
安裝
一殿托、Node.js安裝
swagger是用node寫的霹菊,所以需要先按照node支竹。安裝nodejs后node和npm會一并安裝。
windows中直接運行node-v8.1.2-x64.msi 即可完成安裝(我已經(jīng)下載好饶碘,位于:\\10.9.60.201\shares\)
二馒吴、node中http-server安裝
任一cmd窗口扎运,執(zhí)行npm install -g http-server
三、下載swagger-editor
安裝swagger-editor有多種方式洞拨,
l從github下載安裝鬼吵。 這個方式可能行不通篮赢,因為下載通常很慢齿椅。
l從官網(wǎng)下載swagger-editor.zip启泣,解壓即可。(已共享)
四寥茫、啟動swagger-editor
在swagger-editor的根目錄打開cmd窗口,執(zhí)行http-server芭梯,默認為8080端口弄喘,若想更換端口則使用如下命令http-server –p 80 或者修改:C:\Users\Administrator\AppData\Roaming\npm\node_modules\http-server\bin\http-server中84行portfinder.basePort = 8080; 改為自己想要的端口。
五蘑志、使用瀏覽器訪問http://localhost
結(jié)果:
說明:
界面左邊是api文件的yaml描述文件,左邊部分可以直接編輯API文檔澎媒,編輯會立即更新到右邊視圖波桩。右邊是swagger-UI戒努,可以查看文檔镐躲,并直接進行API的測試。