OpenAPI

E97058

API description specification OpenAPI version industry consortium machine-readable API format open standard

OpenAPI is a widely adopted, language-agnostic specification for describing and documenting RESTful APIs in a standardized, machine-readable format.

Predicate	Object
instanceOf	API description specification → OpenAPI version → OpenAPI version → industry consortium → machine-readable API format → open standard →
definesComponent	callbacks → components → examples → headers → links → parameters → paths → requestBodies → responses → schemas → securitySchemes →
describes	RESTful APIs →
enables	API testing automation → automatic client generation → automatic server stub generation → interactive API documentation → machine-readable API descriptions →
hasAbbreviation	OAS →
hasAlternativeName	OpenAPI Specification →
hasPredecessor	Swagger Specification →
hasVersion	3.0.0 → 3.0.1 → 3.0.2 → 3.0.3 → 3.1.0 →
isHostedBy	Linux Foundation →
isLanguageAgnostic	true →
isMaintainedBy	OpenAPI Initiative →
isProtocolAgnostic	true →
isUsedFor	API governance → API lifecycle management → API-first development → contract-first API design →
originatedFrom	Swagger →
standardizes	API contracts → API documentation →
supportsFormat	JSON → YAML →
supportsHTTPMethod	DELETE → GET → HEAD → OPTIONS → PATCH → POST → PUT → TRACE →
usesSchemaLanguage	JSON Schema (from 3.1.0) →

Subject (surface form when different)	Predicate
ReDoc ("OpenAPI Specification") → ReDoc ("Swagger Specification") → Swagger UI ("OpenAPI Specification") →	supportsSpecification
Swagger UI ("OpenAPI 2.0") → Swagger UI ("OpenAPI 3.0.x") → Swagger UI ("OpenAPI 3.1.x") →	supportsSpecificationVersion
ReDoc ("OpenAPI 2.0") → ReDoc ("OpenAPI 3.0") → ReDoc ("OpenAPI 3.1") →	supportsVersion
FastAPI →	documentationFormat
OpenAPI ("OpenAPI Specification") →	hasAlternativeName
OpenAPI ("Swagger Specification") →	hasPredecessor
JSON API ("OpenAPI Specification") →	relatedTo