Swagger UI搭配Nodejs使用 - 讓API更直觀
專案開發中前後端互動比較多,其中最重要的就是介面的交接,常用的介面交接方式就是用的Excel、doc,介面檢視不是特別直觀和美觀,今天介紹一個可以在web介面顯示API的方式。
Swagger是一個REST APIs文件線上自動生成和測試的框架,預設已經有nodejs環境。
1、建立node-swagger目錄並安裝express
選擇一個合適目錄執行以下命令

npm init
執行後根據提示選擇合適的輸入,然後在執行以下命令安裝express

2、建立public目錄


目錄結構
3、新增swagger官方demo
- 下載swagger相關檔案。
可以利用git clone https://github.com/swagger-api/swagger-ui.git
但是檔案數太多,下載慢,我是在github下zip檔案。
- 解壓後將
dist
目錄下的檔案全部拷貝到 步驟2 中的/public
下。
4、編寫nodejs指令碼,啟動swaggerUI
在 /node-swagger
新建 index.js
檔案,內容如下:
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
啟動專案,訪問瀏覽器輸入 http://localhost:3000/static/index.html
即可檢視相關效果。