API Evangelist API Evangelist
API Learnings
Toolbox
API Evangelist LLC

Parameter Enumerators

Requiring that all operational parameters enums meets the policy standards.

Rules

OpenAPI Components Parameters Enum Casing Error

Keeping parameters enumerator casing consistent across APIs helps reduce confusion by consumers, and can keep aligned with services and applications putting an API to work

OpenAPI Components Parameters Enum Casing Info

Keeping parameters enumerator casing consistent across APIs helps reduce confusion by consumers, and can keep aligned with services and applications putting an API to work

OpenAPI Components Parameters Enum Info

Giving enums for your parameters helps reduce errors and keeps the inputs for your API requests more consistent for consumers

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...