Redocly's visual reference to OpenAPI

Before you start, it's helpful to:

The OpenAPI Specification

From the specification:

The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to HTTP 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.

Restated: OpenAPI describes HTTP APIs (sometimes referred to as REST APIs). It can be generated and consumed by both machines and people.

Structure of this visual reference

Navigate throughout the OpenAPI file structure, and each page contains:

  • Excerpts from the OAS
  • YAML examples with Redocly rendered screenshots
  • Type definitions (which is how you can interact with specs programmatically using rules and decorators).

Difference from Swagger

Swagger is the former name of OpenAPI.

In 2015, SmartBear Software donated the Swagger specification to the Linux Foundation, and renamed the specification to the OpenAPI Specification.

Interested in the origin of the swagger name? Perfect for API trivia.

OpenAPI file structure

An OpenAPI file is a YAML or JSON file with these root mapping keys:

The Redocly type to describe the root is DefinitionRoot.

As a quick refresher from YAML maps, the order of the keys isn't important, so these may appear in any order within the OpenAPI root document.

The following is an example of a minimal OpenAPI 3.0 file:

Copy
Copied
openapi: 3.0.3
info:
  title: Minimal example
  version: demo
paths: {}

Note that the three required root mapping keys have their own required properties.

Reference structure