OasDocument

The root document of an OpenAPI Specification.

The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.

An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.

See: https://swagger.io/specification/

Members

Variables

components
OasComponents components;

An element to hold various schemas for the specification.

externalDocs
OasExternalDocumentation externalDocs;

Additional external documentation.

info
OasInfo info;
Undocumented in source.
openapi
string openapi;

The semantic version number of the OpenAPI Specification.

paths
OasPathItem[string] paths;

**REQUIRED**. The available paths and operations for the API.

security
OasSecurityRequirement[] security;

A list of named securitySchemes that can be used to access this API.

servers
OasServer[] servers;
Undocumented in source.
tags
OasTag[] tags;

A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the OasOperation object must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique.

Meta