OpenAPI components
The section of an OpenAPI document that holds reusable definitions, such as schemas, parameters and responses, referenced from operations.
In more detail
Operations point to these shared definitions with a $ref instead of repeating them. Defining each message shape once stops the same shape drifting between endpoints.
Related terms
- OpenAPI — A standard, language-neutral format for describing an HTTP API: its paths, operations, parameters, request and response schemas, errors and security.
- JSON Schema — A standard vocabulary for describing the allowed shape of JSON data: which fields exist, their types, which are required and what values are allowed.
Taught in
- OpenAPI And Design-First — Modern API Architecture: REST, GraphQL & gRPC