Interface OpenAPIObject

OpenAPI 3.1 document.

interface OpenAPIObject {
    components?: ComponentsObject;
    info: OpenAPIInfo;
    openapi: "3.1.0";
    paths: PathsObject;
    security?: Record<string, string[]>[];
    servers?: OpenAPIServer[];
}

Index

Properties

components? info openapi paths security? servers?

Properties

`Optional`components

components?: ComponentsObject

Reusable components.

info

info: OpenAPIInfo

API info.

openapi

openapi: "3.1.0"

OpenAPI version.

paths

paths: PathsObject

API paths.

`Optional`security

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

Global security requirements.

`Optional`servers

servers?: OpenAPIServer[]

Server list.