Interface Document<T>

interface Document {
    components?: ComponentsObject;
    externalDocs?: ExternalDocumentationObject;
    info: InfoObject;
    openapi: string;
    paths: PathsObject<T, {}>;
    security?: SecurityRequirementObject[];
    servers?: ServerObject[];
    tags?: TagObject[];
    x-express-openapi-additional-middleware?: (((request, response, next) => Promise<void>) | ((request, response, next) => void))[];
    x-express-openapi-validation-strict?: boolean;
}

Type Parameters

  • T extends {} = {}

Properties

components? externalDocs? info openapi paths security? servers? tags? x-express-openapi-additional-middleware? x-express-openapi-validation-strict?

Properties

Optional components

components?: ComponentsObject

Optional externalDocs

externalDocs?: ExternalDocumentationObject

info

info: InfoObject

openapi

openapi: string

paths

paths: PathsObject<T, {}>

Type declaration

    Optional security

    security?: SecurityRequirementObject[]

    Optional servers

    servers?: ServerObject[]

    Optional tags

    tags?: TagObject[]

    Optional x-express-openapi-additional-middleware

    x-express-openapi-additional-middleware?: (((request, response, next) => Promise<void>) | ((request, response, next) => void))[]

    Optional x-express-openapi-validation-strict

    x-express-openapi-validation-strict?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc