Menu
CoddyTech

Ordenação

Parte da seção APIs REST do Journey de Node.js da Coddy. Lição 16 de 25.

Um cliente quer as tarefas mais recentes primeiro ou a lista de A a Z. Uma convenção comum é ?sort=field, com um - na frente para inverter:

// GET /api/books?sort=-year
const field = sort.startsWith('-') ? sort.slice(1) : sort;   // 'year'
const direction = sort.startsWith('-') ? -1 : 1;
list = list.toSorted((a, b) => (a[field] - b[field]) * direction);

Confira primeiro se field está entre os campos permitidos e responda com 400 para qualquer outro, pois um campo que os livros não têm não resulta em uma ordenação útil. toSorted retorna uma cópia ordenada. sort reordena o próprio array e, quando nenhum filtro criou uma cópia, esse array é o armazenamento: todas as solicitações posteriores veem a nova ordem. Este exemplo subtrai, o que funciona apenas para números. Para comparar duas strings, use a.localeCompare(b): assim como a subtração, ele retorna um número negativo, 0 ou um número positivo. Datas ISO são strings que são ordenadas cronologicamente.

challenge icon

Desafio

Fácil

Substitua a ordenação apenas por título que você escreveu em Ordenando texto pelo tratamento de campo e direção abaixo.

Os clientes querem as tarefas mais recentes primeiro ou a lista de A a Z. Deixe a lista se ordenar com ?sort=.

  1. Em routes/tasks.js, na rota da lista, leia sort de req.query. Sem esse parâmetro, a lista mantém a ordem armazenada.
  2. ?sort=title ordena pelo título de A a Z. ?sort=createdAt ordena pela data de criação, da mais antiga para a mais recente. Um - no início inverte a ordem: ?sort=-title é de Z a A, e ?sort=-createdAt mostra as mais recentes primeiro.
  3. Ambos os campos são texto. createdAt é uma data ISO, como "2026-03-03T10:30:00.000Z", que é ordenada corretamente como texto. Portanto, compare com localeCompare, em vez de subtrair.
  4. Qualquer outro campo, como ?sort=color, retorna o status 400:
    { "error": { "code": "invalid_query", "message": "sort must be title or createdAt, with - in front to reverse" } }
  5. Ordene depois dos filtros, para que ?done=false&sort=-title retorne as tarefas abertas de Z a A.
  6. Ordene uma cópia com toSorted. sort reordena o próprio array armazenado, e todas as solicitações posteriores veriam a nova ordem.

Experimente: GET /api/tasks?sort=title retorna as tarefas 2, 3, 1 ("Book...", "Send...", "Write..."). GET /api/tasks?sort=-createdAt retorna 3, 2, 1. Em seguida, GET /api/tasks sem parâmetros retorna 1, 2, 3 novamente. GET /api/tasks?sort=color retorna 400 com o código invalid_query.

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 por PUT. .strict() rejeita campos que não estão na 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();

// Verdadeiro quando outra tarefa já tem este título, independentemente de maiúsculas ou minúsculas.
const titleTaken = (title, exceptId) =>
    tasks.some((t) => t.id !== exceptId && t.title.toLowerCase() === title.toLowerCase());

router.get('/', (req, res) => {
    const { done, q } = 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 (req.query.sort === 'title') {
        list = list.toSorted((a, b) => a.title.localeCompare(b.title));
    }
    res.json(list);
});

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/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;

Todas as lições de APIs REST

Pratique por conta própria: Playground de Express