API Evangelist API Evangelist
API Learnings
Toolbox
API Evangelist LLC

Contact Information for APIs

Requiring that there is a contact included in the OpenAPI info.

Rules

OpenAPI Info Contact Error

You need a contact object associated with the technical contract so that anyone who comes across the API has someone to contact and get more information

OpenAPI Info Contact Info

You need a contact object associated with the technical contract so that anyone who comes across the API has someone to contact and get more information

OpenAPI Info Contact Name Error

You need a contact name associated with the technical contract so that anyone who comes across the API knows who to contact

OpenAPI Info Contact Name Info

You need a contact name associated with the technical contract so that anyone who comes across the API knows who to contact

OpenAPI Info Contact Email Error

You need a contact email address associated with the technical contract so that anyone who comes across the API has someone to email and get more information

OpenAPI Info Contact Email Info

You need a contact email address associated with the technical contract so that anyone who comes across the API has someone to email and get more information

OpenAPI Info Contact Url Error

You need a contact url associated with the technical contract so that anyone who comes across the API knows where to go to contact someone

OpenAPI Info Contact Url Info

You need a contact url associated with the technical contract so that anyone who comes across the API knows where to go to contact someone

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