Interface IDocument

OpenAPI document structure.

interface IDocument {
    components?: OpenApiV3.IComponents;
    info?: OpenApiV3.IDocument.IInfo;
    openapi: `3.0.${number}` | "3.0";
    paths?: Record<string, OpenApiV3.IPath>;
    security?: Record<string, string[]>[];
    servers?: OpenApiV3.IServer[];
    tags?: OpenApiV3.IDocument.ITag[];
}

Index

Properties

components? info? openapi paths? security? servers? tags?

Properties

`Optional`components

components?: OpenApiV3.IComponents

Reusable components.

`Optional`info

info?: OpenApiV3.IDocument.IInfo

API metadata.

openapi

openapi: `3.0.${number}` | "3.0"

OpenAPI version.

`Optional`paths

paths?: Record<string, OpenApiV3.IPath>

API paths and operations.

`Optional`security

security?: Record<string, string[]>[]

Global security requirements.

`Optional`servers

servers?: OpenApiV3.IServer[]

List of servers.

`Optional`tags

tags?: OpenApiV3.IDocument.ITag[]

Tag definitions.