OpenAPI

A standard, language-neutral format for describing an HTTP API: its paths, operations, parameters, request and response schemas, errors and security.

In more detail

An OpenAPI document is written in YAML or JSON and can be read by people and tools alike: documentation viewers, client generators, mock servers and contract tests. Version 3.1 uses JSON Schema for its data shapes. The older name Swagger survives in some tools.

Example

In this course: Tools can check requests and responses against an OpenAPI document, which gives a schema-based alternative or complement to consumer-driven contracts. It was formerly called Swagger.

Related terms

Taught in

References

Certification courses