ToolkitX
知识库工具箱

REST API 设计

RESTful 原则、状态码、错误处理

25min·进阶

01. RESTful 设计

REST 使用 HTTP 方法操作资源。资源使用名词表示,操作使用动词(HTTP 方法)表示。
javascript
// 资源设计
// GET    /api/users          - 获取用户列表
// GET    /api/users/:id      - 获取单个用户
// POST   /api/users          - 创建用户
// PUT    /api/users/:id      - 更新用户
// DELETE /api/users/:id      - 删除用户

// 状态码
// 200 OK
// 201 Created
// 204 No Content
// 400 Bad Request
// 401 Unauthorized
// 404 Not Found

02. 实现示例

一个完整的 REST API 示例,包含 CRUD 操作和数据验证。
javascript
let users = [];
let nextId = 1;

app.get("/api/users", (req, res) => {
res.json(users);
});

app.post("/api/users", (req, res) => {
const { name, email } = req.body;
if (!name || !email) {
    return res.status(400).json({ error: "姓名和邮箱必填" });
}
const user = { id: nextId++, name, email };
users.push(user);
res.status(201).json(user);
});

app.delete("/api/users/:id", (req, res) => {
const index = users.findIndex(u => u.id === parseInt(req.params.id));
if (index === -1) {
    return res.status(404).json({ error: "用户不存在" });
}
users.splice(index, 1);
res.status(204).send();
});

知识测验

1/5正确 0

PUT 和 PATCH 的区别是什么?

下一节

认证与授权

下一节