API Evangelist API Evangelist
API Learnings
Toolbox
API Evangelist LLC

Schema Names

Requiring that all schema names meets the policy standards.

Rules

OpenAPI Schema Names Pascal Case Error

Schema names are pascal case, keeping the naming of them consistent across APIs, standardizing how consumers can use in their applications

OpenAPI Schema Names Pascal Case Info

Schema names are pascal case, keeping the naming of them consistent across APIs, standardizing how consumers can use in their applications

OpenAPI Schema Names Length Error

Schema needs a length limit applied keeping the names of schema consistent across APIs

Strategies

Data Should Be Well-Defined and Validated

The schema behind your APIs is where the rubber meets the road. If your data does not have a well-known shape, if it is not validated on the way in and out, you are setting consumers up for surpris...