API Evangelist API Evangelist
API Learnings
Toolbox
API Evangelist LLC

Request Bodies

Requiring that all operational request bodies meets the policy standards.

Rules

OpenAPI Request Bodies Description Error

It is helpful to provide a description for request bodies, giving a simple explanation of what can be configured as part of the request payload

OpenAPI Request Bodies Description Info

It is helpful to provide a description for request bodies, giving a simple explanation of what can be configured as part of the request payload

OpenAPI Request Bodies Required Property Error

It is important to be explicit about whether or not the request body for an API operation is required or not

OpenAPI Request Bodies Required Property Info

It is important to be explicit about whether or not the request body for an API operation is required or not

OpenAPI Request Body Content On Put Info

PUT requests with a request body needs content defined, giving more detail on what is contained within the API request body

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