interface OpenApiDocument
Since 0.1.0

OpenAPI 3.1 document structure.

Properties

readonly
openapi: string

OpenAPI version.

readonly
info: { readonly title: string; readonly version: string; readonly description?: string; }

API metadata.

readonly
optional
servers: readonly { readonly url: string; readonly description?: string; }[]

Server URLs.

readonly
paths: Record<
string,
{ readonly get?: OpenApiOperation; readonly post?: OpenApiOperation; readonly put?: OpenApiOperation; readonly patch?: OpenApiOperation; readonly delete?: OpenApiOperation; readonly head?: OpenApiOperation; readonly options?: OpenApiOperation; }
>

API paths.

readonly
optional
security: readonly SecurityRequirement[]

Document-level security requirements, applied to every operation that does not declare its own. An operation opts out with security: [].

readonly
optional
components: { readonly schemas?: Record<string, OpenApiSchemaObject>; readonly securitySchemes?: Record<string, unknown>; }

Reusable components.

Usage

import { type OpenApiDocument } from "openapi-plugin/src/index.ts";