Stratal API Reference
    Preparing search index...

    Interface RouteConfig

    Route configuration for @Route() decorator Defines OpenAPI metadata for a controller method

    interface RouteConfig {
        body?: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>;
        description?: string;
        hideFromDocs?: boolean;
        params?: RouteParameter;
        query?: RouteParameter;
        response: RouteResponse;
        security?: SecurityScheme[];
        summary?: string;
        tags?: string[];
    }
    Index

    Properties

    body? description? hideFromDocs? params? query? response security? summary? tags?

    Properties

    Optionalbody

    body?: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

    Request body schema (for POST, PUT, PATCH)

    description?: string

    Human-readable description for OpenAPI docs

    hideFromDocs?: boolean

    Hide this route from OpenAPI documentation Route remains functional but won't appear in /api/docs or /api/openapi.json Useful for internal-only endpoints, debug routes, or work-in-progress features

    params?: RouteParameter

    URL parameters schema (e.g., { id: z.string().uuid() }) Must be ZodObject or ZodPipe for OpenAPI compatibility

    query?: RouteParameter

    Query parameters schema (e.g., pagination, filters) Must be ZodObject or ZodPipe for OpenAPI compatibility

    response: RouteResponse

    Response schema for success case Status code auto-derived: create()->201, others->200

    userSchema or { schema: userSchema, description: 'User details' }
    security?: SecurityScheme[]

    Security schemes required for this route Merged with controller-level security Empty array = public route (no auth)

    summary?: string

    Detailed summary for OpenAPI docs

    tags?: string[]

    OpenAPI tags for grouping endpoints Merged with controller-level tags

    Settings

    Member Visibility

    On This Page

    Properties