Requiring that there is a contact included in the OpenAPI info.
Contact Information for APIs
Rules
OpenAPI Info Contact Error
Having a contact object associated with the technical contract ensures that anyone who comes across the API has someone to contact and get more information
OpenAPI Info Contact Info
Having a contact object associated with the technical contract ensures that anyone who comes across the API has someone to contact and get more information
OpenAPI Info Contact Name Error
Having a contact name associated with the technical contract ensures that anyone who comes across the API knows who to contact
OpenAPI Info Contact Name Info
Having a contact name associated with the technical contract ensures that anyone who comes across the API knows who to contact
OpenAPI Info Contact Email Error
Having a contact email address associated with the technical contract ensures that anyone who comes across the API has someone to email and get more information
OpenAPI Info Contact Email Info
Having a contact email address associated with the technical contract ensures that anyone who comes across the API has someone to email and get more information
OpenAPI Info Contact Url Error
Having a contact url associated with the technical contract ensures that anyone who comes across the API knows where to go to contact someone
OpenAPI Info Contact Url Info
Having a contact url associated with the technical contract ensures that anyone who comes across the API knows where to go to contact someone
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...
