iT邦幫忙

2025 iThome 鐵人賽

DAY 15
0
自我挑戰組

API 全攻略系列 第 15

Day 15: 建立第一個簡單的 API(Node.js / Express)

  • 分享至 

  • xImage
  •  

前言

經過前 14 天的基礎理論,我們終於要來實作第一個簡單的 API 了!今天我們會透過 Node.js 與 Express ,建立一個簡單的 RESTful API,體驗 API 是如何運作的。


為什麼選擇 Express?

  • 輕量且簡單 :快速建立伺服器與路由。
  • 廣泛使用 :社群資源豐富,遇到問題容易找到解法。
  • 擴充性強 :能配合中介層(Middleware)處理各種需求。

建立專案

首先,我們需要建立一個 Node.js 專案並安裝 Express:

# 建立資料夾
mkdir my-first-api
cd my-first-api

# 初始化 Node.js 專案
npm init -y

# 安裝 Express
npm install express

接著,建立一個 index.js 檔案作為主程式。


撰寫第一個 API

在 index.js 中輸入以下程式碼:

const express = require('express');
const app = express();
const port = 3000;

// 中介層:讓 Express 能解析 JSON
app.use(express.json());

// 建立一個簡單的 GET API
app.get('/', (req, res) => {
  res.send('Hello API!');
});

// 模擬一個 Todo 列表的 API
const todos = [
  { id: 1, task: '學習 API 基礎', done: true },
  { id: 2, task: '撰寫第一個 API', done: false }
];

// 取得所有 Todo
app.get('/api/todos', (req, res) => {
  res.json(todos);
});

// 啟動伺服器
app.listen(port, () => {
  console.log(`Server is running at http://localhost:${port}`);
});

測試 API

  1. 啟動伺服器:
node index.js
  1. 開啟瀏覽器或 Postman,訪問:

範例回應:

[
  { "id": 1, "task": "學習 API 基礎", "done": true },
  { "id": 2, "task": "撰寫第一個 API", "done": false }
]

結論

今天我們完成了第一個 API:

  • 學會如何使用 Express 建立伺服器
  • 建立一個簡單的路由
  • 回傳 JSON 格式的資料

上一篇
Day 14: API 錯誤處理設計
系列文
API 全攻略15
圖片
  熱門推薦
圖片
{{ item.channelVendor }} | {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言