Beignet API reference
    Preparing search index...

    Interface OpenAPIConfig

    OpenAPI route handler configuration.

    interface OpenAPIConfig {
        description?: string;
        enabled?: boolean;
        suggestedPath?: string;
        title?: string;
        version?: string;
    }
    Index

    Properties

    description? enabled? suggestedPath? title? version?

    Properties

    description?: string

    API description

    enabled?: boolean

    Enable OpenAPI endpoint (default: false)

    suggestedPath?: string

    Suggested path for the OpenAPI endpoint (e.g., "/api/openapi.json"). NOTE: This field is for documentation/metadata only and does not control routing. You must manually wire the openapiHandler to your desired route.

    title?: string

    API title

    version?: string

    API version

    Settings

    Member Visibility

    On This Page

    Properties