API Evangelist API Evangelist
API Learnings
Toolbox
API Evangelist LLC

Version of APIs

Requiring the info version property meets the policy standards.

Rules

OpenAPI Info Version Error

Publishing a version for your OpenAPI technical contract helps you communicate change with consumers using Semantic or date-based versioning published to the info version property

OpenAPI Info Version Info

Publishing a version for your OpenAPI technical contract helps you communicate change with consumers using Semantic or date-based versioning published to the info version property

OpenAPI Version Date Info

Publishing a version for your OpenAPI technical contract helps you communicate change with consumers using date-based versioning published to the info version property

OpenAPI Version Semantic Info

Publishing a version for your OpenAPI technical contract helps you communicate change with consumers using Semantic versioning published to the info version property

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

API Versioning Follows a Defined Standard

Versioning is where the technology and politics of API operations collide. Semantic versioning, date-based versioning--pick a strategy and stick with it. What matters most is that consumers know ho...