OPENAPI-3-1-DETAIL

REST API spec aligned with JSON Schema.

Definition

OpenAPI 3.1 introduces full alignment with JSON Schema 2020-12 (versus 3.0 which was a dialect subset). Supports webhooks, multiple media types, unbounded $ref, true OAS Common Annotations. Ecosystem tools: Swagger UI, ReDoc, Postman import, Spectral linting, openapi-generator CLI (~70 languages). Successor of OpenAPI 3.0.x published 2017.

Origin

OpenAPI 3.1.0 published 17 February 2021 by OpenAPI Initiative ; OpenAPI 3.0.0 published 2017 ; Swagger 2.0 published 2014.

Example in context

Stripe API documents its ~5000 endpoints in OpenAPI 3.1 YAML ; auto-generated SDKs for Python, Node.js, Java, Go via openapi-generator.

Related terms

• AsyncAPI 3 — event-driven twin.