如何使用 Node.js Express 建構 RESTful Web API
How to use Node.js Express?
本文章將介紹如何使用 Node.js Express 框架 架設 RESTful Web API.
基本工具
基本提要
- Node.js: Node.js採用Google開發的V8執行程式碼,使用事件驅動、非阻塞和非同步輸入輸出模型等技術來提高效能,可優化應用程式的傳輸量和規模。這些技術通常用於資料密集的實時應用程式。
- Experss: Express 是最小又靈活的 Node.js Web 應用程式架構,為 Web 與行動式應用程式提供一組健全的特性。
建置 server
我們使用 npm init 初始化裝置
- 安裝 Node.js
- 打開你的編輯器(推薦使用 VSCode)
- 新建一個空資料夾,打開在資料夾位子下的終端機
- 輸入
npm init
,基本上都使用預設值(按 enter 下一步)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
| package name: (nodeexpress) version: (1.0.0) description: entry point: (index.js) test command: git repository: keywords: author: license: (ISC) About to write to /Users/username/Documents/nodeExpress/package.json:
{ "name": "nodeexpress", "version": "1.0.0", "description": "", "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "author": "", "license": "ISC" }
Is this OK? (yes) y
|
- 輸入
npm install express --save
安裝 express 框架
此時檔案結構如下:
nodeExpress
├── node_modules
├── package-lock.json
└── package.json
- 增加檔案
server.js
並且寫入 code
1 2 3 4 5 6 7 8 9 10
| const express = require('express');
const app = express();
app.listen(3030, err => { console.log('listen to port: 3030'); });
|
現在在終端機輸入 node serve
, 出現 listen to port: 3030
就是成功囉。你已經建置一個伺服器。
創建 RESTful API
現在我們要製作一個 get 方法的 API
邏輯如下:
- 在
server.js
底下繼續增加
1 2 3 4 5
| app.get("/", (req, res) => { res.json({ message:'successful' }); });
|
- 運行
node server
,打開瀏覽器輸入 http://localhost:3030/
你將會看見:
1 2 3
| { "message": "successful" }
|
- 恭喜 您已經完成了一個 RESTful API 實作,然而
Node.js
與 Express
肯定不只這樣!
讓我們下次見。附上 server.js
全部程式碼:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
| const express = require('express');
const app = express();
app.listen(3030, err => { console.log('listen to port: 3030'); });
app.get("/", (req, res) => { res.json({ message:'successful' }); });
|