API Evangelist API Evangelist
API Learnings
APIs
API Governance
API Solutions
API Discovery
API Building Blocks
API Evangelist LLC

OpenAPI Component Headers

Keeping up with the latest versions of the specification.

HTTP headers are essential to the transport of APIs, and the OpenAPI specification provides a central components storage for HTTP headers, which can then be referenced across API requests and responses. OpenAPI ensures that HTTP headers are properly documented across all APIs.

All HTTP headers should be centralized using the components header object in OpenAPI, then just referenced in the request and response for each individual operation. Having these headers defined ensures they show in documentation, but also available as part of testing and other types of automation.