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

OpenAPI Operation Parameters

Keeping up with the latest versions of the specification.

Each operation can come with an assortment of path, query, and header parameters, depending on how the HTTP protocol is being used as a transport, and an API has been designed. The OpenAPI specification comes with the ability to define parameters for each operation, centralize those parameters for use across many different APIs, and empower consumers to configure their API requests.

I recommend that you centralize all OpenAPI parameters using the components object. While there may be a small percentage of unique API parameters, centralizing provide a lot more benefits for auditing, reuse, and governance across many APIs. Operation parameters are the configuration surface for individual APIs, and collectively they are how you standardize the optimization of your enterprise at scale across domains, lines of business, and teams.