Как проверять входные данные через Zod?
На этой странице
TypeScript проверяет код во время разработки, но не проверяет данные из сети. Zod выполняет проверку во время работы программы и возвращает типизированный результат.
Вопрос
Как проверять входные данные Express API через Zod? Почему типов TypeScript для этого недостаточно?
Установка
npm install zodСхема создания пользователя
import { z } from "zod";
export const createUserSchema = z
.object({
name: z.string().trim().min(2).max(100),
email: z.string().trim().email().max(255).toLowerCase(),
})
.strict();
export type CreateUserInput = z.infer<typeof createUserSchema>;.strict() запрещает неизвестные поля. Это помогает заметить опечатку клиента.
Проверка тела
app.post("/api/users", async (request, response) => {
const result = createUserSchema.safeParse(request.body);
if (!result.success) {
response.status(400).json({
error: {
code: "VALIDATION_ERROR",
message: "Проверь данные запроса",
details: result.error.issues.map((issue) => ({
path: issue.path.join("."),
message: issue.message,
})),
},
});
return;
}
const input = result.data;
response.status(201).json({ data: input });
});Используй result.data, а не исходный request.body: именно результат прошёл проверку и преобразование.
Проверка параметра пути
const idParamsSchema = z.object({
id: z.coerce.number().int().positive(),
});
const { id } = idParamsSchema.parse(request.params);z.coerce.number() преобразует строку "42" в число 42 и затем проверяет его.
Схема частичного изменения
export const updateUserSchema = createUserSchema
.partial()
.refine((value) => Object.keys(value).length > 0, {
message: "Передай хотя бы одно поле",
});Все поля становятся необязательными, но пустой объект не принимается.
Повторно используемый обработчик
import type { RequestHandler } from "express";
import type { ZodType } from "zod";
export function validateBody(schema: ZodType): RequestHandler {
return (request, response, next) => {
const result = schema.safeParse(request.body);
if (!result.success) {
response.status(400).json({
error: {
code: "VALIDATION_ERROR",
message: "Неверные данные",
details: result.error.issues,
},
});
return;
}
request.body = result.data;
next();
};
}usersRouter.post("/", validateBody(createUserSchema), createUser);Валидация не заменяет ограничения базы
Zod проверит формат почты, но уникальность должна дополнительно обеспечиваться ограничением UNIQUE в PostgreSQL. Между проверкой и записью другой запрос может занять ту же почту.
Что важно помнить
safeParse()не бросает исключение и возвращаетsuccessиdataилиerrorс подробностями.- После проверки используется только
result.data, а не исходныйrequest.body. z.coerce.number()превращает строковыеparamsиqueryв числа.- Для частичного изменения удобна схема
.partial()от схемы создания. - Уникальность и связи всё равно защищает PostgreSQL: проверка в приложении не видит одновременных запросов.
Мини-шпаргалка
- TypeScript не проверяет сетевые данные во время работы.
safeParse()возвращает успех или подробную ошибку.- Используй проверенное
result.data. z.coerceпреобразует строковые параметры.- Проверка приложения дополняет, но не заменяет ограничения PostgreSQL.