Stone.js API
    Preparing search index...

    Interface OpenApiDecoratorOptions

    Options for the @OpenApi decorator: the stone.openapi bucket, every key optional.

    interface OpenApiDecoratorOptions {
        deriveFromRouter?: boolean;
        docsPath?: string | false;
        document?: OpenApiDocument;
        info?: OpenApiInfo;
        routes?: OpenApiRoute[];
        securityScheme?: string;
        servers?: { description?: string; url: string }[];
        specPath?: string;
        swaggerUi?: SwaggerUiOptions;
    }

    Hierarchy (View Summary)

    Index
    deriveFromRouter? docsPath? document? info? routes? securityScheme? servers? specPath? swaggerUi?
    deriveFromRouter?: boolean

    Stop deriving from the router and describe only what routes declares.

    Off by default, because deriving is the point.

    docsPath?: string | false

    Where the explorer is served (default /docs). Set to false to serve only the JSON.

    document?: OpenApiDocument

    A pre-built document, when the application assembles its own.

    info?: OpenApiInfo

    Document metadata (title, version, description).

    routes?: OpenApiRoute[]

    Routes to describe by hand.

    Rarely needed: the contract derives itself from the router. Anything declared here is added on top of what was derived, for an endpoint the router does not own.

    securityScheme?: string

    The security scheme name a protected route requires. Default 'bearerAuth'.

    servers?: { description?: string; url: string }[]

    Server URLs to advertise. Omitted, the URL of the request that asked is used.

    specPath?: string

    Where the JSON document is served (default /openapi.json).

    swaggerUi?: SwaggerUiOptions

    Swagger UI rendering options.

    Settings
    Member Visibility

    On This Page
    Properties