Zod on API Routes Next.js: qat'iy, chiziqli va aslida qo'shimcha maydonlardan himoya qiladigan narsa
Biz qanday muammoni hal qilyapmiz?
Odatda qattiq tekshirish bilan birgalikda muhokama qilinadigan ikkita hujum:
- Ommaviy tayinlash. Mijoz profilni yangilash so‘nggi nuqtasiga
{"name":"Ivan","role":"admin"}ni yuboradi va serverdb.user.update({ data: body })ni yuboradi.rolemaydoni ma'lumotlar bazasiga kiradi. - Prototip ifloslanishi. Korpusda
__proto__yokiconstructor.prototypekaliti mavjud va kod uni o'z-o'zidan yozilgandeepMergeorqali ob'ektga rekursiv birlashtiradi, prototipniObjecto'zgartiradi.
Ikkala zaiflik ham .strict() yo'qligidan emas, balki serverning xom so'rov tanasidan foydalanishidan kelib chiqadi. Agar siz Zod orqali tasdiqlasangiz va faqat parse natijasi bilan ishlasangiz, qo‘shimcha kalitlar strictsiz ham u erga etib bormaydi: sukut bo‘yicha, z.object ularni o‘chirib tashlaydi (chiziq rejimi).
Uchta ob'ekt rejimi
import { z } from "zod";
const Base = { name: z.string().min(1).max(100) };
z.object(Base).parse({ name: "a", role: "admin" });
// { name: "a" } — role молча удалён
z.object(Base).strict().parse({ name: "a", role: "admin" });
// ZodError: unrecognized key "role"
z.object(Base).passthrough().parse({ name: "a", role: "admin" });
// { name: "a", role: "admin" } — опасно для входных данныхZod 4da bir xil rejimlar alohida konstruktorlar z.strictObject({...}) va z.looseObject({...}) sifatida mavjud; .strict() va .passthrough() usullari muvofiqlik uchun saqlanadi. Har bir loyiha uchun bitta uslubni tanlang.
Nima uchun strict? Bu jim o'chirishni aniq xatoga aylantiradi. Maydon nomini noto‘g‘ri yozgan mijoz (email o‘rniga emial) elektron pochtasiz “muvaffaqiyatli” saqlash o‘rniga, kalit bilan 400 oladi. Ichki API va shakllar uchun bu soatlab nosozliklarni tuzatishni tejaydi.
Ishlovchi shablon
// app/api/profile/route.ts
import { z } from "zod";
import { NextResponse } from "next/server";
import { getSession } from "@/lib/auth";
import { db } from "@/lib/db";
const Address = z.strictObject({
city: z.string().max(80),
street: z.string().max(120),
});
const UpdateProfile = z.strictObject({
name: z.string().trim().min(1).max(100).optional(),
email: z.email().optional(), // в Zod 3: z.string().email()
address: Address.optional(),
});
export async function PATCH(req: Request) {
const session = await getSession();
if (!session) return NextResponse.json({ error: "unauthorized" }, { status: 401 });
let json: unknown;
try {
json = await req.json();
} catch {
return NextResponse.json({ error: "invalid JSON" }, { status: 400 });
}
const parsed = UpdateProfile.safeParse(json);
if (!parsed.success) {
return NextResponse.json(
{ error: "validation", issues: parsed.error.issues.map(i => ({ path: i.path, message: i.message })) },
{ status: 400 }
);
}
// только parsed.data, никогда json
const user = await db.user.update({ where: { id: session.userId }, data: parsed.data });
return NextResponse.json({ id: user.id, name: user.name, email: user.email });
}Ko'pincha o'tkazib yuboriladigan tafsilotlar:
- `strict` rekursiv emas. Qattiq ob'ekt ichidagi ichki joylashtirilgan
z.objectchiziqli rejimda qoladi. Shuning uchunAddressalohida qattiq deb e'lon qilinadi. - `req.json()` noto'g'ri JSONda istisnolarni chiqaradi.
try/catchsiz mijoz 400 oʻrniga 500 oladi. - `safeParse` `parse` o'rniga - oddiy foydalanuvchi xatolari uchun istisnolardan qochish uchun.
- Javob ham filtrlanadi. Parol xeshi bilan butun foydalanuvchi ob'ektini emas, balki aniq maydonlar to'plamini qaytaring.
So'rov parametrlari va shakllari
searchParams va FormData dan kelgan hamma narsa satrdir. Castdan foydalaning:
const ListQuery = z.strictObject({
page: z.coerce.number().int().min(1).default(1),
limit: z.coerce.number().int().min(1).max(100).default(20),
q: z.string().max(200).optional(),
});
const query = ListQuery.safeParse(Object.fromEntries(new URL(req.url).searchParams));Object.fromEntries ikki nusxadagi parametrlarni yo'qotadi (?tag=a&tag=b). Agar ular kerak bo'lsa, searchParams.getAll("tag") orqali massivni alohida yig'ing.
Qanday qilib tashxis qo'yish kerak
- Mobil ilova chiqqandan so'ng mijoz 400 ga yaqin shikoyat qiladi: yangi versiya qo'shimcha maydonni yuboradi, ammo sxema qat'iy. Javobda
issuesga qarang - kalitga boradigan yo'l o'sha erda bo'ladi. - Maydon "saqlanmagan", hech qanday xatolik yo'q: sxema qat'iy emas va kalit siz kutganingizdan boshqacha chaqiriladi.
strictni vaqtincha yoqing va so‘rovni qaytadan urinib ko‘ring. - Kalitlardagi
__proto__jurnallarida - skaner prototip ifloslanishini qidiradi. Agar sizparsed.datadan foydalansangiz, bu shovqin; Birlashtirish kodida xom ashyolar mavjudligini tekshiring.
Qattiqqo'l to'sqinlik qilganda
Tashqi xizmatlarning veb-huklari (to'lov tizimlari, messenjerlar) muntazam ravishda yangi maydonlarni qo'shib turadi. Ularning qat'iy sxemasi zararsiz provayder yangilanishini ishlov berishdagi nosozlikka aylantiradi. Bunday kirishlar uchun chiziq rejimidan foydalaning va faqat kerakli maydonlarni tavsiflang. Orqaga mos keladigan umumiy API uchun ham xuddi shunday: oxirgi nuqtalarning eski versiyalaridagi qat'iy sxema yangi versiyalardan maydonlarni yuboradigan mijozlarni buzishi mumkin.