API Evangelist API Evangelist
API Learnings
Toolbox
API Evangelist LLC

Schema Property Names

Requiring that all schema property names meets the policy standards.

Rules

OpenAPI Schema Properties Names Camel Case Error

Schema property names are camel case, giving consistent casing across all the schema properties used by APIs

OpenAPI Schema Properties Names Camel Case Info

Schema property names are camel case, giving consistent casing across all the schema properties used by APIs

OpenAPI Schema Properties Names Length Error

Schema property names have a length restriction applied, keeping names consistent, and avoiding being too long

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