API Evangelist API Evangelist
API Learnings
Toolbox
API Evangelist LLC

Parameters

Requiring that all operational parameters meets the policy standards.

Rules

OpenAPI Parameters Componentized Error

You need all parameters using the central OpenAPI components parameters object helps increase the reusability of parameters across API operations, but it also help standardize parameter across all ...

OpenAPI Parameters Componentized Info

You need all parameters using the central OpenAPI components parameters object helps increase the reusability of parameters across API operations, but it also help standardize parameter across all ...

Strategies

Operations Must Be Useful and Consistent

Every API operation should do one thing and do it well. That is the Unix philosophy applied to APIs and it still holds up. When your operations follow common standards with consistent naming, clear...

API Parameters Are Well-Defined and Consistent

Parameters are part of the surface area that consumers interact with on every single call, and when they are inconsistent--different casing, unclear names, missing descriptions--it creates friction...