标签
本课属于 Coddy Node.js 学习旅程的“REST API”单元。第 24 课,共 25 课。
任务会被标上 office 或 money 这样的标签,而看板应用需要一个菜单,列出所有标签及其对应的任务数量。这一步会添加三项内容:列表的 schema 规则、筛选器,以及统计标签数量的路由。下面介绍如何将数量统计到一个对象中,这是新内容。
// schema 中的 genres:z.array(z.string()).max(3).optional()
const counts = {};
for (const book of books) {
for (const genre of book.genres) {
counts[genre] = (counts[genre] ?? 0) + 1;
}
}
// { poetry: 2, drama: 1 }Object.entries(counts) 会将该对象转换为 [["poetry", 2], ...] 这样的键值对,可以直接映射为列表。这样的摘要本身就是一种资源,也有自己的 URL。
optional() 允许这个字段缺省,同时仍会在字段存在时检查其值。使用 Object.entries(counts).map(([genre, count]) => ({ genre, count })) 将键值对转换为对象:方括号会解包每个键值对;圆括号会返回一个对象。
挑战
简单看板应用希望按标签(如 office 或 money)对任务分组,并显示一个菜单,列出每个标签及带有该标签的任务数量。为你的 API 添加标签。
- 在
routes/tasks.js中,为Task架构添加一个可选的labels字段:这是一个最多包含 5 个标签的列表,每个标签在去除首尾空格后是一个长度为 1 到 20 个字符的字符串。POST 和 PATCH 也会使用这个字段,因为它们的架构基于Task构建。无效列表会触发常见的 400invalid_body错误。无效列表包括"labels": "office"(这是文本,不是列表)、"labels": [""],以及包含 6 个标签的列表。 - 每个保存的任务都有一个
labels列表:- 如果 POST 或 PUT 没有发送
labels,就保存为[]。PUT 会替换整个任务,因此不带标签的 PUT 会清除标签。 - 只有 PATCH 发送了
labels时,才会更改标签。
- 如果 POST 或 PUT 没有发送
- 在
store.js中,为初始任务添加标签:任务 1 和 2 使用["office"],任务 3 使用["money"]。 - 仍在
routes/tasks.js中,为列表路由添加筛选条件:GET /api/v1/tasks?label=office只返回labels中恰好包含office的任务。它可以像之前一样与其他筛选条件和分页一起使用。 - 在
server.js中,在路由器挂载处旁边添加GET /api/v1/labels,并在此处从store.js导入tasks。它会返回当前使用的每个标签,以及带有该标签的任务数量,并按标签的字母顺序排序。对于初始任务,返回结果如下:[ { "label": "money", "count": 1 }, { "label": "office", "count": 2 } ]
试试看:
GET /api/v1/labels会返回上面的列表。- 向
/api/v1/tasks发送 POST{ "title": "Order chairs", "labels": ["office"] }:你会得到 201,新任务包含"labels": ["office"]。此时GET /api/v1/labels会显示office的"count": 3。 - 发送 POST
{ "title": "Water the plants" }:新任务包含"labels": []。 GET /api/v1/tasks?label=money只会返回任务 3。GET /api/v1/tasks?label=nope会返回"items": []和"total": 0。- 使用
{ "title": "Book the meeting room", "done": false }发送PUT /api/v1/tasks/2,会返回包含"labels": []的任务 2。
亲手试试
import { Router } from 'express';
import { z } from 'zod';
import { config } from '../config.js';
import { sendError, sendInvalid } from '../errors.js';
import { nextId, tasks } from '../store.js';
const router = Router();
// 完整的任务,格式与 PUT 发送的一样。.strict() 会拒绝未列出的字段。
const Task = z
.object({
title: z.string().trim().min(1).max(100),
done: z.boolean(),
})
.strict();
const NewTask = Task.partial({ done: true });
const TaskChanges = Task.partial();
const SORT_FIELDS = ['title', 'createdAt'];
// 不区分大小写,只要另一个任务已有这个标题,就返回 True。
const titleTaken = (title, exceptId) =>
tasks.some((t) => t.id !== exceptId && t.title.toLowerCase() === title.toLowerCase());
router.get('/', (req, res) => {
const { done, q, sort } = req.query;
let list = tasks;
if (done !== undefined) {
if (done !== 'true' && done !== 'false') {
return sendError(res, 400, 'invalid_query', 'done must be true or false');
}
list = list.filter((t) => t.done === (done === 'true'));
}
if (q !== undefined) {
const words = String(q).toLowerCase();
list = list.filter((t) => t.title.toLowerCase().includes(words));
}
if (sort !== undefined) {
const field = String(sort).startsWith('-') ? String(sort).slice(1) : String(sort);
if (!SORT_FIELDS.includes(field)) {
return sendError(
res,
400,
'invalid_query',
'sort must be title or createdAt, with - in front to reverse',
);
}
const direction = String(sort).startsWith('-') ? -1 : 1;
list = list.toSorted((a, b) => a[field].localeCompare(b[field]) * direction);
}
const page = req.query.page === undefined ? 1 : Number(req.query.page);
const limit = req.query.limit === undefined ? config.pageSize : Number(req.query.limit);
if (!Number.isInteger(page) || page < 1) {
return sendError(res, 400, 'invalid_query', 'page must be a whole number from 1');
}
if (!Number.isInteger(limit) || limit < 1 || limit > 50) {
return sendError(res, 400, 'invalid_query', 'limit must be a whole number from 1 to 50');
}
const start = (page - 1) * limit;
res.json({
items: list.slice(start, start + limit),
page,
total: list.length,
pages: Math.ceil(list.length / limit),
});
});
router.get('/:id', (req, res) => {
const task = tasks.find((t) => t.id === Number(req.params.id));
if (!task) {
return sendError(res, 404, 'not_found', 'Task not found');
}
res.json(task);
});
router.post('/', (req, res) => {
const result = NewTask.safeParse(req.body);
if (!result.success) {
return sendInvalid(res, result.error);
}
const { title, done = false } = result.data;
if (titleTaken(title)) {
return sendError(res, 409, 'conflict', 'A task with this title already exists');
}
const task = { id: nextId(), title, done, createdAt: new Date().toISOString() };
tasks.push(task);
res.status(201).location(`/api/v1/tasks/${task.id}`).json(task);
});
router.patch('/:id', (req, res) => {
const task = tasks.find((t) => t.id === Number(req.params.id));
if (!task) {
return sendError(res, 404, 'not_found', 'Task not found');
}
const result = TaskChanges.safeParse(req.body);
if (!result.success) {
return sendInvalid(res, result.error);
}
if (result.data.title !== undefined && titleTaken(result.data.title, task.id)) {
return sendError(res, 409, 'conflict', 'A task with this title already exists');
}
Object.assign(task, result.data);
res.json(task);
});
router.put('/:id', (req, res) => {
const index = tasks.findIndex((t) => t.id === Number(req.params.id));
if (index === -1) {
return sendError(res, 404, 'not_found', 'Task not found');
}
const result = Task.safeParse(req.body);
if (!result.success) {
return sendInvalid(res, result.error);
}
const { id, createdAt } = tasks[index];
if (titleTaken(result.data.title, id)) {
return sendError(res, 409, 'conflict', 'A task with this title already exists');
}
tasks[index] = { id, ...result.data, createdAt };
res.json(tasks[index]);
});
router.delete('/:id', (req, res) => {
const index = tasks.findIndex((t) => t.id === Number(req.params.id));
if (index === -1) {
return sendError(res, 404, 'not_found', 'Task not found');
}
tasks.splice(index, 1);
res.status(204).end();
});
export default router;
REST API中的所有课
自己练习: Express 在线编辑器