Route Parameters with Zod

Koritsu supports dynamic routes with parameters using Zod schemas for type safety and automatic documentation generation.

Dynamic Routes

Create dynamic routes using bracket notation in folder names:

routes/
  users/
    [id]/
      route.ts
    profile/
      route.ts

Parameter Definition

Use Zod schemas to define route parameters in your route specs. Koritsu supports four types of parameters that are automatically extracted and validated:

typescript

export const GET = createRoute({
  method: "GET",
  handler: async ({ params, query, request }) => {
    // Path parameters
    const { id } = params; // From /users/[id]

    // Query parameters (with defaults applied)
    const { limit, offset, search } = query;

    // Use parameters in your logic
    const users = await getUsersWithFilters({
      id,
      limit,
      offset,
      search,
    });

    return Response.json(users);
  },
  spec: {
    format: "json",
    summary: "Get user by ID with optional filters",
    description: "User data with filters applied",
    parameters: {
      // Path parameters (from dynamic routes like [id])
      path: z.object({
        id: z.string().describe("The unique user identifier"),
        categoryId: z.string().optional().describe("Optional category filter"),
      }),

      // Query parameters (?limit=10&offset=0&search=john)
      query: z.object({
        limit: z
          .number()
          .min(1)
          .max(100)
          .default(10)
          .describe("Number of results to return"),
        offset: z
          .number()
          .min(0)
          .default(0)
          .describe("Number of results to skip"),
        search: z.string().optional().describe("Search term to filter users"),
        active: z.boolean().default(true).describe("Filter by active status"),
      }),
    },
    responses: {
      200: {
        // ... response schema
      },
    },
  },
});

// Example with POST request and body validation
export const POST = createRoute({
  method: "POST",
  handler: async ({ body }) => {
    // Body is automatically validated and typed
    const { name, email, age } = body;

    const newUser = await createUser({
      name,
      email,
      age,
    });

    return Response.json(newUser, { status: 201 });
  },
  spec: {
    format: "json",
    summary: "Create a new user",
    description: "Creates a new user with the provided information",
    parameters: {
      // Request body validation
      body: z.object({
        name: z.string().min(1).max(100).describe("User's full name"),
        email: z.string().email().describe("User's email address"),
        age: z.number().min(18).max(120).describe("User's age"),
        bio: z.string().optional().describe("Optional user biography"),
      }),
    },
    responses: {
      201: {
        schema: z.object({
          id: z.string().uuid(),
          name: z.string(),
          email: z.string(),
          age: z.number(),
          createdAt: z.string(),
        }),
      },
      400: {
        description: "Invalid request data",
      },
    },
  },
});

Parameter Types

Parameter Type	Location	Example	Description
Path	URL segments	`/users/[id]`	Dynamic route segments
Query	URL query string	`?limit=10&search=john`	Optional filters and pagination
Headers	HTTP headers	`accept-language: en`	Content negotiation and metadata
Body	Request body	`{"name": "John Doe"}`	Data payload for POST/PUT/PATCH

Accessing Parameters in Routes

Parameters are automatically parsed and provided to your route handlers:

typescript

export const GET = createRoute({
  method: "GET",
  handler: async ({ params, query, headers, request }) => {
    // Path parameters
    const { id } = params; // From /users/[id]

    // Query parameters (with defaults applied)
    const { limit, offset, search } = query;

    // Headers
    const acceptLanguage = headers["accept-language"];

    // Use parameters in your logic
    const users = await getUsersWithFilters({
      id,
      limit,
      offset,
      search,
    });

    return Response.json(users);
  },
  // ... spec definition
});

export const POST = createRoute({
  method: "POST",
  handler: async ({ body, headers, request }) => {
    // Request body (automatically parsed and validated)
    const { name, email, preferences } = body;

    // Headers for content negotiation
    const contentType = headers["content-type"];

    // Create new resource
    const user = await createUser({ name, email, preferences });

    return Response.json(user, { status: 201 });
  },
  // ... spec definition
});

export const PUT = createRoute({
  method: "PUT",
  handler: async ({ params, body, query, request }) => {
    // All parameter types available together
    const { id } = params; // Path parameter
    const { userData } = body; // Request body
    const { force } = query; // Query parameter

    const result = await updateUser(id, userData, { force });
    return Response.json(result);
  },
  // ... spec definition
});

Request Body Validation

For POST, PUT, and PATCH requests, you can validate request bodies using Zod schemas. The framework automatically parses JSON bodies and validates them against your schema:

typescript

// routes/users/route.ts
import { createRoute } from "koritsu";
import { z } from "zod";

export const POST = createRoute({
  method: "POST",
  handler: async ({ body }) => {
    // body is automatically parsed and validated
    const { name, email, profile } = body;

    const newUser = await database.users.create({
      name,
      email,
      profile,
    });

    return Response.json(newUser, { status: 201 });
  },
  spec: {
    format: "json",
    summary: "Create a new user",
    description: "Creates a new user with the provided information",
    parameters: {
      body: z.object({
        name: z.string().min(1).max(100).describe("User's full name"),
        email: z.string().email().describe("Valid email address"),
        profile: z
          .object({
            bio: z.string().optional().describe("User biography"),
            website: z.string().url().optional().describe("Personal website"),
            location: z.string().optional().describe("User location"),
          })
          .optional()
          .describe("Optional profile information"),
        preferences: z
          .object({
            theme: z.enum(["light", "dark"]).default("light"),
            notifications: z.boolean().default(true),
          })
          .optional()
          .describe("User preferences"),
      }),
    },
    responses: {
      201: {
        schema: z.object({
          id: z.string().uuid(),
          name: z.string(),
          email: z.string(),
          createdAt: z.string(),
        }),
      },
      400: {
        description: "Invalid request data or validation failed",
      },
    },
  },
});

// Complex example with nested validation
export const PUT = createRoute({
  method: "PUT",
  handler: async ({ params, body }) => {
    const { id } = params;
    const userData = body;

    const updatedUser = await database.users.update(id, userData);

    if (!updatedUser) {
      return Response.json({ error: "User not found" }, { status: 404 });
    }

    return Response.json(updatedUser);
  },
  spec: {
    format: "json",
    summary: "Update an existing user",
    description: "Updates user information with the provided data",
    parameters: {
      path: z.object({
        id: z.string().uuid().describe("User ID to update"),
      }),
      body: z
        .object({
          name: z.string().min(1).max(100).optional(),
          email: z.string().email().optional(),
          profile: z
            .object({
              bio: z.string().max(500).optional(),
              website: z.string().url().optional(),
              avatar: z.string().url().optional(),
            })
            .optional(),
          settings: z
            .object({
              privacy: z.enum(["public", "private", "friends"]).optional(),
              emailNotifications: z.boolean().optional(),
            })
            .optional(),
        })
        .refine((data) => Object.keys(data).length > 0, {
          message: "At least one field must be provided for update",
        }),
    },
    responses: {
      200: {
        schema: z.object({
          id: z.string().uuid(),
          name: z.string(),
          email: z.string(),
          updatedAt: z.string(),
        }),
      },
      400: {
        schema: z.object({
          error: z.string(),
          details: z.array(
            z.object({
              code: z.string(),
              message: z.string(),
            })
          ),
        }),
      },
      404: {
        schema: z.object({
          error: z.string(),
        }),
      },
    },
  },
});

Body Validation Features

Automatic JSON parsing: Request bodies are automatically parsed from JSON
Type safety: TypeScript types are inferred from your Zod schemas
Nested objects: Support for complex nested object validation
Custom validation: Use Zod's .refine() for custom validation logic
Optional fields: Mark fields as optional with .optional()
Default values: Provide defaults with .default(value)
Validation errors: Automatic 400 responses for invalid data

Body Validation Error Responses

When body validation fails, the framework returns structured error responses:

json

{
  "error": "Parameter validation failed",
  "details": [
    {
      "code": "invalid_type",
      "expected": "string",
      "received": "number",
      "path": ["name"],
      "message": "Invalid input: expected string, received number"
    },
    {
      "code": "invalid_string",
      "validation": "email",
      "path": ["email"],
      "message": "Invalid email format"
    }
  ]
}

Supported Parameter Types & Validation

Koritsu automatically converts Zod schemas to OpenAPI parameter definitions and provides runtime validation:

Basic Types

typescript

z.string(); // String parameter
z.number(); // Numeric parameter
z.boolean(); // Boolean parameter (true/false)
z.date(); // Date parameter (ISO string)

Advanced Types

typescript

// Enums with specific values
z.enum(["active", "inactive", "pending"]);

// Arrays (query: ?tags=frontend,backend,api)
z.array(z.string());

// Optional parameters
z.string().optional();

// Parameters with default values
z.number().default(10);

// Parameters with validation
z.string().min(3).max(50);
z.number().min(1).max(100);
z.string().email();
z.string().uuid();

// Nested objects (for body parameters)
z.object({
  profile: z.object({
    bio: z.string().optional(),
    avatar: z.string().url().optional(),
  }),
  preferences: z.object({
    theme: z.enum(["light", "dark"]),
    notifications: z.boolean(),
  }),
});

// Arrays of objects (for body parameters)
z.array(
  z.object({
    name: z.string(),
    value: z.string(),
  })
);

// Union types (multiple possible types)
z.union([z.string(), z.number()]);

// Custom validation with refine
z.string().refine((val) => val.startsWith("user_"), {
  message: "ID must start with 'user_'",
});

// Parameters with descriptions (for OpenAPI docs)
z.string().describe("User's unique identifier");

Type Coercion & Validation

The framework automatically:

Converts types: Strings to numbers, "true"/"false" to booleans
Validates constraints: Min/max values, string patterns, required fields
Applies defaults: Missing optional parameters get default values
Generates errors: Returns 400 Bad Request for invalid parameters

typescript

// Example with comprehensive validation
query: z.object({
  page: z.number().min(1).default(1).describe("Page number"),
  size: z.number().min(10).max(100).default(20).describe("Items per page"),
  sort: z.enum(["name", "date", "popularity"]).default("name"),
  filter: z.string().min(2).optional().describe("Search filter"),
  active: z.boolean().default(true),
  tags: z.array(z.string()).optional(),
});

Error Handling

When parameter validation fails, the framework automatically returns structured error responses:

json

{
  "error": "Parameter validation failed",
  "details": [
    {
      "code": "too_small",
      "minimum": 1,
      "type": "number",
      "inclusive": true,
      "exact": false,
      "message": "Number must be greater than or equal to 1",
      "path": ["query", "page"]
    }
  ]
}

Complete Example: Advanced Route with Parameters

typescript

// routes/users/[id]/route.ts
import { createRoute } from "koritsu";
import { z } from "zod";

export const GET = createRoute({
  method: "GET",
  handler: async ({ params, query }) => {
    // All parameters are typed and validated
    const { id } = params; // string (required)
    const { include, limit } = query; // string[] | undefined, number

    try {
      const user = await getUserById(id, {
        include,
        limit,
      });

      return Response.json(user);
    } catch (error) {
      if (error.code === "USER_NOT_FOUND") {
        return Response.json({ error: "User not found" }, { status: 404 });
      }
      throw error; // Let framework handle other errors
    }
  },
  spec: {
    format: "json",
    summary: "Get user by ID with optional includes",
    description: "Fetches user data along with requested related information",
    parameters: {
      path: z.object({
        id: z.string().uuid().describe("User's UUID"),
      }),
      query: z.object({
        include: z
          .array(z.enum(["profile", "posts", "followers"]))
          .optional()
          .describe("Related data to include"),
        limit: z
          .number()
          .min(1)
          .max(50)
          .default(10)
          .describe("Limit for included items"),
      }),
    },
    responses: {
      200: {
        schema: z.object({
          id: z.string().uuid(),
          name: z.string(),
          email: z.string().email(),
          profile: z
            .object({
              bio: z.string(),
              website: z.string().url(),
            })
            .optional(),
          posts: z
            .array(
              z.object({
                id: z.string().uuid(),
                title: z.string(),
                content: z.string(),
              })
            )
            .optional(),
          followers: z
            .array(
              z.object({
                id: z.string().uuid(),
                name: z.string(),
              })
            )
            .optional(),
        }),
      },
      400: {
        schema: z.object({
          error: z.string(),
          details: z.array(
            z.object({
              code: z.string(),
              message: z.string(),
            })
          ),
        }),
      },
      404: {
        schema: z.object({
          error: z.string(),
        }),
      },
    },
  },
});

Best Practices for Parameter Definition

Always provide descriptions for clear API documentation:
typescript
```
id: z.string().uuid().describe("User's unique identifier");
```

Use appropriate validation for data integrity:

typescript

email: z.string().email().describe("User's email address");
limit: z.number().min(1).max(100).describe("Results per page");

Provide sensible defaults for optional parameters:

typescript

page: z.number().min(1).default(1);
sortOrder: z.enum(["asc", "desc"]).default("asc");

Group related parameters logically:

typescript

parameters: {
  path: z.object({
    /* path params */
  }),
  query: z.object({
    /* query params */
  }),
  headers: z.object({
    /* headers */
  }),
};

Use enums for controlled values instead of free-form strings:
typescript
```
status: z.enum(["active", "inactive", "suspended"]);
```

The framework automatically:

Extracts the id parameter from the URL path
Validates it against the Zod schema
Generates OpenAPI documentation with proper parameter definitions
Provides type-safe access in your route handlers

Route Parameters with Zod ​

Dynamic Routes ​

Parameter Definition ​

Parameter Types ​

Accessing Parameters in Routes ​

Request Body Validation ​

Body Validation Features ​

Body Validation Error Responses ​

Supported Parameter Types & Validation ​

Basic Types ​

Advanced Types ​

Type Coercion & Validation ​

Error Handling ​

Complete Example: Advanced Route with Parameters ​

Best Practices for Parameter Definition ​

Route Parameters with Zod

Dynamic Routes

Parameter Definition

Parameter Types

Accessing Parameters in Routes

Request Body Validation

Body Validation Features

Body Validation Error Responses

Supported Parameter Types & Validation

Basic Types

Advanced Types

Type Coercion & Validation

Error Handling

Complete Example: Advanced Route with Parameters

Best Practices for Parameter Definition