vaso991/koa-router-zod-swagger

README

koa-router-zod-swagger

Validate router input and host swagger ui based on @koa/router and zod schema

Version Compatibility

koa-router-zod-swagger@^2 is compatible with zod@^4.
koa-router-zod-swagger@^1 remains available for zod@^3.

Installation

$ npm install koa-router-zod-swagger zod

$ pnpm install koa-router-zod-swagger zod

Uses Zod@v4, @koa/router And koa2-swagger-ui

Usage

Import Packages

import Koa from 'koa';
import KoaRouter from 'koa-router';
import { z } from 'zod';
import {
  ZodValidator,
  ZodValidatorProps,
  KoaRouterSwagger,
  setZodValidatorGlobalConfig,
} from 'koa-router-zod-swagger';
const app = new Koa();
const router = new KoaRouter();

Create validation Zod object schema (See Zod Documentation)

const RouterSchema: ZodValidatorProps = {
  summary: 'Make test post request',
  description: `Make [API](https://en.wikipedia.org/wiki/API) Request`,
  query: z.object({
    queryParam: z.string(),
  }),
  body: z.object({
    bodyParamString: z.string(),
    bodyParamNumber: z.number(),
  }),
  files: {
    file1: true,
    multipleFiles: {
      multiple: true
    },
    optionalFile: {
      optional: true
    }
  },
  filesValidator: z.object({
    file1: z.object({ // formidable.File object
      size: z.number().min(5 * 1000).max(7 * 1000), // Min 5KB, Max 7KB.
      mimetype: z.enum(['image/png'])
    })
  }),
  params: z.object({
    param1: z.string(),
  }),
  header: z.object({
    'user-agent': z.string()
  }),
  response: {
    description: 'Response returned successfully',
    validate: true,
    body: z.object({
      query: z.object(),
      params: z.object(),
      body: z.object()
    })
  }
};

Validate

router.post('/api/:param1', ZodValidator(RouterSchema), (ctx) => {
  ctx.body = {
    query: ctx.request.query,
    params: ctx.params,
    body: ctx.request.body,
  };
});

`assignParsedData`

By default ZodValidator validates the request but leaves the raw request data untouched. Zod schemas can also transform values (e.g. z.coerce.number() turns the string "42" into the number 42). Setting assignParsedData writes the parsed (and transformed) result back to the request so your handler receives the coerced types.

Accepted values:

Value	Effect
`false` / omitted	Validate only — request data unchanged
`true`	Write parsed result back for all targets
`['query', 'params', 'body', 'header', 'files']`	Write back only for the listed targets

Set globally

Applies to every route unless overridden per-route:

setZodValidatorGlobalConfig({
  assignParsedData: true,
  toJsonSchemaOptions: {
    target: 'draft-2020-12',
  },
});

Override per route

A per-route value always takes precedence over the global setting:

router.get(
  '/items',
  ZodValidator({
    query: z.object({ page: z.coerce.number() }),
    assignParsedData: ['query'], // only write back query, regardless of global config
  }),
  (ctx) => {
    ctx.request.query.page; // number, not string
  },
);

Serve Swagger Docs (pass koa2-swagger-ui config as `uiConfig`)

router.get(
  '/docs',
  KoaRouterSwagger(router, {
    routePrefix: false,
    title: 'Test Api',
    swaggerOptions: {
      spec: {
        info: {
          version: '1.0.0',
          description: 'This is test api specs',
        },
      },
    },
  }),
);