swagger在node.js下的使用

swagger的使用

1.使用swagger-codegen生成server端的controller

兩種方式:

  • 下載源碼,編譯日戈,用swagger-codegen-cli.jar命令生成(麻煩,windows)
git clone https://github.com/swagger-api/swagger-codegen
cd swagger-codegen
mvn clean package
java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
  -i http://petstore.swagger.io/v2/swagger.json \
  -l nodejs-server \
  -o samples/server/petstore/nodejs(生成目錄)
  • 用homebrew安裝,用swagger-codegen命令生成(簡單,mac)
brew install swagger-codegen
swagger-codegen generate \
-i http://petstore.swagger.io/v2/swagger.json \
-l nodejs-server \
-o tmp/test/

服務器端代碼生成后酬诀,可通過http://127.0.0.1:port/docs看到當前api文件生成的UI

注:
-i 表示的輸入的yaml或者json文件地址
-l 表示生成的代碼類型昏兆。例如:nodejs-server表示用nodejs寫的服務端,html表示客 戶端
-o 表示輸出文件夾

2.swagger-editor

  • 在線編輯:http://editor.swagger.io/
  • 本地編輯:
    • git clone https://github.com/swagger-api/swagger-editor.git 將源碼下載到本地
    • cd swagger-editor
    • http-server -p 8000
    • 瀏覽器登錄http://127.0.0.1:8000(與在線編輯界面一樣)

3.swagger-ui

  • git clone https://github.com/swagger-api/swagger-ui.git將源碼下載到本地
  • cd swagger-ui/dist/ (可將dist目錄下的文件拷貝到任意位置盾鳞,執(zhí)行下面兩步)
  • index.js里面引入json文件的url改成你的api的json文件的地址
  • http-server -p 8000
  • 瀏覽器登錄http://127.0.0.1:8000 可看到在線的API文檔
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市瞻离,隨后出現(xiàn)的幾起案子腾仅,更是在濱河造成了極大的恐慌,老刑警劉巖套利,帶你破解...
    沈念sama閱讀 218,284評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件推励,死亡現(xiàn)場離奇詭異,居然都是意外死亡肉迫,警方通過查閱死者的電腦和手機验辞,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,115評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來喊衫,“玉大人跌造,你說我怎么就攤上這事∽骞海” “怎么了壳贪?”我有些...
    開封第一講書人閱讀 164,614評論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長寝杖。 經(jīng)常有香客問我违施,道長,這世上最難降的妖魔是什么朝墩? 我笑而不...
    開封第一講書人閱讀 58,671評論 1 293
  • 正文 為了忘掉前任醉拓,我火速辦了婚禮,結(jié)果婚禮上收苏,老公的妹妹穿的比我還像新娘亿卤。我一直安慰自己,他們只是感情好鹿霸,可當我...
    茶點故事閱讀 67,699評論 6 392
  • 文/花漫 我一把揭開白布排吴。 她就那樣靜靜地躺著,像睡著了一般懦鼠。 火紅的嫁衣襯著肌膚如雪钻哩。 梳的紋絲不亂的頭發(fā)上屹堰,一...
    開封第一講書人閱讀 51,562評論 1 305
  • 那天,我揣著相機與錄音街氢,去河邊找鬼扯键。 笑死,一個胖子當著我的面吹牛珊肃,可吹牛的內(nèi)容都是我干的荣刑。 我是一名探鬼主播,決...
    沈念sama閱讀 40,309評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼伦乔,長吁一口氣:“原來是場噩夢啊……” “哼厉亏!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起烈和,我...
    開封第一講書人閱讀 39,223評論 0 276
  • 序言:老撾萬榮一對情侶失蹤爱只,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后招刹,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體恬试,經(jīng)...
    沈念sama閱讀 45,668評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,859評論 3 336
  • 正文 我和宋清朗相戀三年蔗喂,在試婚紗的時候發(fā)現(xiàn)自己被綠了忘渔。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片高帖。...
    茶點故事閱讀 39,981評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡缰儿,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出散址,到底是詐尸還是另有隱情乖阵,我是刑警寧澤,帶...
    沈念sama閱讀 35,705評論 5 347
  • 正文 年R本政府宣布预麸,位于F島的核電站瞪浸,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏吏祸。R本人自食惡果不足惜对蒲,卻給世界環(huán)境...
    茶點故事閱讀 41,310評論 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望贡翘。 院中可真熱鬧蹈矮,春花似錦、人聲如沸鸣驱。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,904評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽踊东。三九已至北滥,卻和暖如春刚操,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背再芋。 一陣腳步聲響...
    開封第一講書人閱讀 33,023評論 1 270
  • 我被黑心中介騙來泰國打工菊霜, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人济赎。 一個月前我還...
    沈念sama閱讀 48,146評論 3 370
  • 正文 我出身青樓占卧,卻偏偏與公主長得像,于是被迫代替她去往敵國和親联喘。 傳聞我的和親對象是個殘疾皇子华蜒,可洞房花燭夜當晚...
    茶點故事閱讀 44,933評論 2 355

推薦閱讀更多精彩內(nèi)容