Wed May 07 2025
TypeSafeに型定義をしてJSONなどのレスポンスをパースできる仕組みです。
ただ単なるパーサーにとどまらず、zod-openapi-clientやzodiosなど様々なところに利用されています。以前ちょっとだけお話したEffectTSはその辺が全然ダメだったイメージがあるのでやはりZod一強なのかなと思っています。
他にもいろいろTypeSafeを実現するためのライブラリはあるのですが、個人的にはZodが一番好きなので愛用しています。
で、これをより便利にジェネリクスを使って定義したいよね、というお話。
{
"data": {
"id": 0
}
}
やりたいこととしてはものすごく簡単で、例えば上のようなレスポンスを返す/v1/blogs/:idがあったとします。で、当然ブログの記事一覧を取得する/v1/blogs/もあるわけですが、そのレスポンスが、
{
"data": [
{
"id": 0
}
]
}
となることが多いわけです。つまり、データ構造はほぼ同じなのに返ってくるのが配列かそうでないかという違いが発生します。
スプラトゥーン3のレスポンスもそうでしたが、ベースとなる構造はほぼ一緒でdataの中身だけが違うということは往々にしてあるわけです。そのとき、毎回全部のレスポンスを定義していたら大変ですよね。なので、ジェネリクスを使いましょう。
さっきのものを何も考えずに定義すると以下のようになります。
const DatumSchema = z.object({
data: z.object({
id: z.number().int()
})
})
const ListDatumSchema = z.object({
data: z.array(z.object({
id: z.number().int()
}))
})
これだけならそんなに苦労じゃないですが、オブジェクトの構造が深くなると面倒です。
const DatumSchema = z.object({
id: z.number().int()
})
const PluralOrSingularSchema = z.object({
data: Datum.or(z.array(Datum))
})
一応このようにも書けるのですが、この場合はdataが配列かそうでないかを毎回チェックする必要が生じ、非常に手間になります。
そこで、dataはZodSchemaに適合していれば何でも受け取れるようにしてしまいます。
conts GenericsSchema = <T extends ZodSchema>(S: T) => z.object({
data: S
})
こうすることでZodSchemaに適合する全てのオブジェクトを引数として受け取れます。
GenericsSchema(DatumSchema).parse(body)
GenericsSchema(z.array(DatumSchema)).parse(body)
とすれば共通のスキーマを利用して使い分けることができます。
dataが何パターンもある場合には、
conts ItemSchema = <T extends ZodSchema>(S: T) => z.object({
data: S
})
conts ListSchema = <T extends ZodSchema>(S: T) => z.object({
data: z.array(S)
})
としても良いかもしれません。
で、こうやって定義したスキーマですが、
const DatumSchema = z.object({
data: z.object({
id: z.number().int()
})
})
export type Datum = z.infer<DatumSchema>
conts ItemSchema = <T extends ZodSchema>(S: T) => z.object({
data: S
})
export type Item<S extends ZodSchema> = z.infer<ReturnType<typeof ItemSchema<S>>>
conts ListSchema = <T extends ZodSchema>(S: T) => z.object({
data: z.array(S)
})
export type List<S extends ZodSchema> = z.infer<ReturnType<typeof ListSchema<S>>
このようにして型を定義します。
受け取る際には、
const list: List<typeof DatumSchema> = ListSchema(DatumSchema).parse(body)
という感じになります。
Listの引数はDatumではなくtypeof DatumSchemaとなるのがポイントです。これを忘れてよくコンパイルが失敗します。
Zodの使い方はしっかり覚えよう。