Conflitos
Parte da seção APIs REST do Journey de Node.js da Coddy. Lição 13 de 25.
Uma segunda tarefa chamada "Send the invoice" deixa a lista confusa, mas seu corpo é válido. Isso é um 409 Conflict: a solicitação entra em conflito com o que já está armazenado. Um 400 significa que o próprio corpo está incorreto.
const taken = users.some((u) => u.name.toLowerCase() === name.toLowerCase());
if (taken) {
return sendError(res, 409, 'conflict', 'That username is taken');
}Compare em letras minúsculas, já que as pessoas consideram "Ada" e "ada" o mesmo nome. Quando uma solicitação renomeia algo, ignore o próprio item na busca. Caso contrário, um usuário que salva o formulário sem alterar o nome entra em conflito consigo mesmo.
Desafio
FácilDuas tarefas chamadas "Send the invoice" deixam a lista confusa. Recuse um título que outra tarefa já tenha.
- Em
routes/tasks.js, compare os títulos sem diferenciar maiúsculas de minúsculas: "Book the meeting room" e "book the MEETING room" contam como o mesmo título. - Em POST, depois que a validação do esquema for aprovada: se alguma tarefa já tiver esse título, use
sendErrorpara responder com status 409 e não adicione nada:{ "error": { "code": "conflict", "message": "A task with this title already exists" } } - Faça o mesmo em PATCH (somente quando o corpo enviar um
title) e em PUT. Nessas duas rotas, exclua a tarefa que está sendo alterada da busca, para que uma tarefa possa manter seu próprio título ou mudar apenas as letras maiúsculas e minúsculas. Uma solicitação PATCH ou PUT recusada não altera nada.
Experimente: envie POST { "title": "book the meeting room" } para /api/tasks: você recebe 409 com o código conflict, porque a tarefa 2 se chama "Book the meeting room". Envie PATCH /api/tasks/3 com { "title": "Write the Project Brief" }: 409, e GET /api/tasks/3 ainda mostra "Send the invoice". Envie PUT /api/tasks/2 com { "title": "Book the meeting room", "done": true }: 200, porque esse é o próprio título da tarefa 2. Envie POST { "title": "Order new chairs" }: 201.
Experimente você mesmo
import { Router } from 'express';
import { z } from 'zod';
import { sendError, sendInvalid } from '../errors.js';
import { nextId, tasks } from '../store.js';
const router = Router();
// Uma tarefa completa, como enviada pelo PUT. .strict() rejeita campos que não estão em sua lista.
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();
router.get('/', (req, res) => {
res.json(tasks);
});
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;
const task = { id: nextId(), title, done, createdAt: new Date().toISOString() };
tasks.push(task);
res.status(201).location(`/api/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);
}
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];
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;
Todas as lições de APIs REST
1Recursos e verbos
Recursos e URLsCriando com POST4Navegadores, versões e configuração
O que é uma origemPermitindo outra origemCORSUma página que chama a APIPratique por conta própria: Playground de Express