next-swagger-doc
    Preparing search index...

    Type Alias SwaggerOptions

    SwaggerOptions: Options & {
        apiFolder?: string;
        autoDoc?: boolean | AutoDocOptions;
        definition: OAS3Definition;
        outputFile?: string;
        scanBuildOutput?: boolean;
        schemaFolders?: string[];
        specFile?: string;
    }

    Type Declaration

    • OptionalapiFolder?: string
    • OptionalautoDoc?: boolean | AutoDocOptions

      Generate basic OpenAPI operations from App Router route files.

    • definition: OAS3Definition
    • OptionaloutputFile?: string

      Write the generated spec to this JSON file.

    • OptionalscanBuildOutput?: boolean

      Glob compiled files under .next/server. Default: only when the source API folder is missing and Next.js is not currently compiling (standalone / runtime fallback).

    • OptionalschemaFolders?: string[]
    • OptionalspecFile?: string

      Load a prebuilt OpenAPI JSON file (for example public/swagger.json). When the file exists it is returned as-is, which is the standalone-output path: generate at build time, serve the file at runtime.

    Settings
    Member Visibility