Swagger簡(jiǎn)介 4
安裝4
一、Node.js安裝4
二、node中http-server安裝4
三、下載swagger-editor 4
四、啟動(dòng)swagger-editor 5
五、使用瀏覽器訪問(wèn)http://localhost 5
使用5
一、編寫(xiě)API文檔：7
二、生成服務(wù)端代碼：8
三、修改&運(yùn)行服務(wù)端：9
四、創(chuàng)建&運(yùn)行客戶端：11
1．?使用swagger-editor的web界面：11
2．?使用swagger-editor生成的客戶端代碼14
3．?使用chrome的postman插件15
Swagger簡(jiǎn)介
Swagger包括Swagger Editor，Swagger UI等很多部分，這里我們主要講一下Swagger Editor。它是一個(gè)完全開(kāi)源的項(xiàng)目，并且它也是一個(gè)基于Angular的成功案例。
在Swagger Editor中，我們可以基于YAML等語(yǔ)法定義我們的RESTful API，然后它會(huì)自動(dòng)生成一篇排版優(yōu)美的API文檔，并且提供實(shí)時(shí)預(yù)覽。簡(jiǎn)單說(shuō)就是可以邊編寫(xiě)API 邊預(yù)覽邊測(cè)試。
在Swagger UI中，我們不能進(jìn)行編寫(xiě)API ，但是我們可以預(yù)覽或者測(cè)試。
安裝
一、Node.js安裝
swagger是用node寫(xiě)的，所以需要先按照node。安裝nodejs后node和npm會(huì)一并安裝。
windows中直接運(yùn)行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下載安裝。 這個(gè)方式可能行不通，因?yàn)橄螺d通常很慢。
l從官網(wǎng)下載swagger-editor.zip，解壓即可。(已共享)
四、啟動(dòng)swagger-editor
在swagger-editor的根目錄打開(kāi)cmd窗口，執(zhí)行http-server，默認(rèn)為8080端口，若想更換端口則使用如下命令http-server –p 80 或者修改：C:\Users\Administrator\AppData\Roaming\npm\node_modules\http-server\bin\http-server中84行portfinder.basePort = 8080; 改為自己想要的端口。
五、使用瀏覽器訪問(wèn)http://localhost
結(jié)果：
說(shuō)明：
界面左邊是api文件的yaml描述文件，左邊部分可以直接編輯API文檔，編輯會(huì)立即更新到右邊視圖。右邊是swagger-UI，可以查看文檔，并直接進(jìn)行API的測(cè)試。
