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

OpenAPI Operation Parameter Names

Keeping up with the latest versions of the specification.

The names of API parameters represent all of the logical knobs and levers that API consumers can pull on when making requests to APIs. The names should augment and enrich the paths, methods, summary, and description of an API operation, but speak to the unique configuration opportunities that exist for the API consumer.

APi parameter names should follow a consistent naming strategy, including the case, type, and other elements as part of the naming, sensibly applying nouns and verbs across the request surface area for an API. Use plain language for your API parameters and consider leveraging a centralized vocabulary for helping normalize and establish a common way of configuring APIs.