Skip to content
CtrlK

OpenApiConfig

On this page
import type { OpenApiConfig } from "ardo/config"

type OpenApiConfig = {
    /** Local OpenAPI 3.0/3.1 JSON or YAML file. Remote URLs are intentionally unsupported. */
    spec: string;
    /** Generated route prefix. Defaults to `api`. */
    out?: string;
};

Properties

NameTypeRequiredDescription
specstringYesLocal OpenAPI 3.0/3.1 JSON or YAML file. Remote URLs are intentionally unsupported.
outstringNoGenerated route prefix. Defaults to api.