API Evangelist API Evangelist
API Learnings
Toolbox
API Evangelist LLC

Schema Type

Requiring that all schema type meets the policy standards.

Rules

OpenAPI Schema Type Error

Schema needs a type defined, being explicit about type of data a schema describes and can be used to validate, helping standardize the type of data being made available

OpenAPI Schema Type Info

Schema needs a type defined, being explicit about type of data a schema describes and can be used to validate, helping standardize the type of data being made available

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