Why use Zod for a GitHub API response that already has @octokit/types?

@octokit/types is exhaustive and bundles every endpoint. A generated Zod schema is tight to the one response your code reads, runs at runtime, and catches GitHub's silent shape changes (preview→GA fields, removed deprecated keys) at the boundary instead of deep inside your script.

Will this work for paginated responses?

Paste a single page of results. Arrays of objects merge into one schema so every item shares the same shape. Wrap the result in z.array yourself if you fetch a collection endpoint that returns a bare array.

What about webhook payloads vs REST responses?

Both work. Webhook bodies are JSON of the same kind, just delivered to your endpoint instead of fetched. Paste the body and you get a Zod schema you can run inside your /github/webhook handler.

GitHub API Response to Zod Schema — /repos/{owner}/{repo} → z.object

JSON input valid

Zod output

About this conversion

GitHub's REST API quietly evolves: fields appear as previews, get GA'd, and occasionally vanish in API version bumps. If your script reads a GitHub response with TypeScript types alone, a missing field crashes only when you reach for it. Wrapping the call in a Zod schema's parse turns that into a single, named error at the boundary — you know exactly which field GitHub didn't send and you can decide to fail closed or fall back. The schema generated here matches the exact JSON shape you paste, so unused fields stay out of the surface area.

The output is a copy-paste-runnable z.object you can import alongside @octokit/rest, the GitHub SDK in any language, or a raw fetch. Use it on rate-limited endpoints (it's cheaper than re-typing every response by hand), in GitHub Actions where dependency size matters, or in webhook receivers where the body is untrusted JSON. Each merged response array becomes a single schema; missing fields across samples become .optional(); nullable fields become z.union with z.null().

GitHub API Response to Zod

About this conversion

Same shape, other validators

Other JSON shapes