Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Title of APIs

Requiring the info title property meets the policy standards.

Rules

OpenAPI Info Title Error

Having a intuitive and helpful title for your API using the OpenAPI info title is the first impression you will make on the consumers of your API

OpenAPI Info Title Info

Having a intuitive and helpful title for your API using the OpenAPI info title is the first impression you will make on the consumers of your API

OpenAPI Info Title Length Error

Having a limitation on the length of the title for your API helps provide constraints for teams naming it, but also keep consistent with other APIs from across teams

OpenAPI Info Title Upper Case Error

Having a consistent casing for the title for your API helps provide constraints for teams naming the API, but also keep consistent with other APIs from across teams

OpenAPI Info Title Upper Case Info

Having a consistent casing for the title for your API helps provide constraints for teams naming the API, but also keep consistent with other APIs from across teams

Strategies

API Info and Metadata Is Complete and Accurate

All OpenAPI definitions must have complete info objects including title, description, version, contact information, license, and terms of service, providing both humans and machines with the contex...

Lifecycle

design_services Design Design

Design is where the human experience of an API is won or lost. I work design-first, shaping the paths, schema, errors, and naming in the contract before development begins, so that consistency is b...