Reference

rouzer/openapi

Functions

`generateOpenAPI`

Generate an OpenAPI 3.1 document from a Rouzer route tree.

export function generateOpenAPI(routes: HttpRouteTree, options: OpenAPIOptions): Record<string, any>;

^{🔍 generateOpenAPI on GitHub}

Types

`OpenAPIOptions`

export type OpenAPIOptions = {
    info: {
        title: string;
        version: string;
        description?: string;
    };
    basePath?: string;
    servers?: Array<{
        url: string;
        description?: string;
    }>;
};

^{🔍 OpenAPIOptions on GitHub}