先把三个任务接口跑通:Fastify 路由里的输入与输出
学完运行机制,终于可以写接口了。先实现三个操作:创建任务、按 ID 查询、列出任务。存储先放进内存,让每次数据变化都容易观察。
这里创建的是任务记录,不会立即执行后台工作。创建完成返回 201;真正的异步执行到第 10 课再加入。
一个文件看完请求的三种输入
在练习工程安装 Fastify 5,将下面文件编译后执行。示例用 inject 驱动请求,稍后再把监听端口放到独立入口。
import Fastify from 'fastify';
import { randomUUID } from 'node:crypto';
import assert from 'node:assert/strict';
type Task = { id: string; title: string; status: 'pending' };
const tasks = new Map<string, Task>();
const app = Fastify();
app.post<{ Body: { title: string } }>('/tasks', async (request, reply) => {
const task: Task = {
id: randomUUID(), title: request.body.title.trim(), status: 'pending',
};
tasks.set(task.id, task);
return reply.code(201).header('location', `/tasks/${task.id}`).send(task);
});
app.get<{ Params: { id: string } }>('/tasks/:id', async (request, reply) => {
const task = tasks.get(request.params.id);
return task ?? reply.code(404).send({ code: 'TASK_NOT_FOUND' });
});
app.get<{ Querystring: { limit?: string } }>('/tasks', async (request, reply) => {
const limit = Number(request.query.limit ?? '20');
if (!Number.isSafeInteger(limit) || limit < 1 || limit > 100) {
return reply.code(400).send({ code: 'INVALID_LIMIT' });
}
return [...tasks.values()].slice(0, limit);
});
try {
const created = await app.inject({
method: 'POST', url: '/tasks', payload: { title: ' 生成摘要 ' },
});
assert.equal(created.statusCode, 201);
const task = created.json<Task>();
assert.equal((await app.inject(`/tasks/${task.id}`)).statusCode, 200);
assert.equal((await app.inject('/tasks/missing')).statusCode, 404);
assert.equal((await app.inject('/tasks?limit=0')).statusCode, 400);
} finally { await app.close(); }
console.log('first-api: passed');
Body、Params、Querystring 这些泛型提供静态描述。创建接口目前只演示合法输入,第 6 课会加入真实 schema;直接给 body 写类型,不会使坏 JSON 自动被拒绝。
flowchart TD
A[HTTP 请求] --> B[路由匹配]
B --> C[读取 body、params 或 query]
C --> D[创建或查询任务记录]
D --> E[选择状态码与响应体]
先让状态码表达真实结果
POST 创建成功用 201,并给出资源地址。GET 找不到返回 404。列表为空则返回空数组,通常仍是 200,不必把“没有元素”和“请求的资源不存在”混在一起。
接口命名也要跟行为一致。这里还没有 Worker,返回的 pending 只说明记录处于等待状态,并不意味着已经有执行器在消费它。将来真正提交异步处理,会明确改成 202 和可查询的任务 ID。
把内存版本的限制留在正确位置
进程重启,Map 中的数据就会消失;多个实例也不会共享它。这正好能说明 repository 的意义:HTTP 层依赖的是存取行为,而不应知道数据究竟在 Map 还是 PostgreSQL。
本例的列表还不是完整的分页协议,只限制返回数量。第 7 课会补上稳定排序与游标,避免数据增加以后靠一次返回全部记录。
运行后,可以增加第二个任务、查询不存在的 ID,再检查 Location 与状态码。接下来将路由里的业务和存储拆开,避免接口越来越多后整个应用只剩一个大文件。
对应第 5 课提纲;路由测试方式见 Fastify Testing.
- 点赞
- 收藏
- 关注作者
评论(0)