Beignet API reference
    Preparing search index...

    Type Alias CreateOpenAPIHandlerOptions

    Options for the Next.js OpenAPI route handler.

    type CreateOpenAPIHandlerOptions = {
        description?: string;
        headers?: HeadersInit | ((req: Request) => HeadersInit | undefined);
        inferServersFromRequest?: boolean;
        jsonMediaType?: string;
        schemaIntrospector?: unknown;
        security?: Record<string, string[]>[];
        securitySchemes?: Record<string, unknown>;
        servers?: OpenAPIServer[] | ((req: Request) => OpenAPIServer[]);
        title: string;
        version: string;
    }
    Index

    Properties

    description? headers? inferServersFromRequest? jsonMediaType? schemaIntrospector? security? securitySchemes? servers? title version

    Properties

    description?: string

    API description.

    headers?: HeadersInit | ((req: Request) => HeadersInit | undefined)

    Additional response headers.

    inferServersFromRequest?: boolean

    Add the current request origin as the OpenAPI server when servers is omitted.

    true
    jsonMediaType?: string

    JSON media type used for generated content.

    schemaIntrospector?: unknown

    Custom schema introspector for non-Zod schema libraries.

    security?: Record<string, string[]>[]

    Global security requirements.

    securitySchemes?: Record<string, unknown>

    OpenAPI security schemes.

    servers?: OpenAPIServer[] | ((req: Request) => OpenAPIServer[])

    Static servers or a request-aware server factory.

    title: string

    API title.

    version: string

    API version.

    Settings

    Member Visibility

    On This Page

    Properties