API Evangelist API Evangelist
API Learnings
Toolbox
API Evangelist LLC

Title of APIs

Requiring the info title property meets the policy standards.

Rules

OpenAPI Info Title Error

You need 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

You need 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

You need 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

You need 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

You need 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

The info object in your OpenAPI definition is the first thing both humans and machines encounter, and I am constantly surprised by how often it is incomplete. Title, description, version, contact, ...