API Evangelist API Evangelist
API Learnings
APIs
API Governance
API Solutions
API Discovery
API Building Blocks
API Evangelist LLC

OpenAPI Schema Names

Keeping up with the latest versions of the specification.

The names of schema, like other naming should be consistent, and adequately describe what a digital object is. Schema names should follow a consistent schema casing, length, and approach across all APIs being made available. Schema names should reflect standardized internal data models, but more importantly be expressed in ways that will be meaningful to the use cases they represent within each API request or response.

Make sure all of the characters used in your schema are actual readable words, and avoid too many acronyms or abbreviations, unless it makes sense otherwise. Keep schema readable and parsable. Schema shouldn’t be cryptic digital blobs, and should reflect the API resources and capabilities of the APIs they are made available in, no matter what team is producing the API.