項(xiàng)目開(kāi)發(fā)中前后端交互比較多帽揪，其中最重要的就是接口的交接硝清，常用的接口交接方式就是用的Excel、doc转晰，接口查看不是特別直觀(guān)和美觀(guān)耍缴，今天介紹一個(gè)可以在web界面顯示API的方式。
Swagger是一個(gè)REST APIs文檔在線(xiàn)自動(dòng)生成和測(cè)試的框架挽霉，默認(rèn)已經(jīng)有nodejs環(huán)境防嗡。
1、創(chuàng)建node-swagger目錄并安裝express
選擇一個(gè)合適目錄執(zhí)行以下命令
npm init執(zhí)行后根據(jù)提示選擇合適的輸入侠坎，然后在執(zhí)行以下命令安裝express
2蚁趁、創(chuàng)建public目錄
目錄結(jié)構(gòu)
3、添加swagger官方demo
- 下載swagger相關(guān)文件实胸。
可以利用git clone https://github.com/swagger-api/swagger-ui.git但是文件數(shù)太多他嫡，下載慢番官，我是在github下zip文件。
- 解壓后將
dist目錄下的文件全部拷貝到步驟2中的/public下钢属。
4徘熔、編寫(xiě)nodejs腳本，啟動(dòng)swaggerUI
在/node-swagger新建index.js文件淆党，內(nèi)容如下：
const path = require('path');
const express = require('express');
const app = express();
app.use('/static', express.static(path.join(__dirname, 'public')));
app.listen(3000, () => console.log('hello~'));
node index.js啟動(dòng)項(xiàng)目酷师，訪(fǎng)問(wèn)瀏覽器輸入http://localhost:3000/static/index.html即可查看相關(guān)效果。
