AsyncAPI Best Practices

general > asyncapi-info-contact

Guidance

An info object should contain a contact object.
Hopefully your API description document is so good that nobody ever needs to contact you with questions, but that
is rarely the case. The contact object has a few different options for contact details.

Message

Include contact information of the person responsible for maintaining this API, so they
can answer any questions.

Examples

valid

asyncapi: 2.0.0
info:
  title: example API
  version: "1.0.0"
  contact:
    url: https://example.com
    name: example
    email: example@example.com
channels: {}

invalid

asyncapi: 2.0.0
info:
  title: example API
  version: "1.0.0"
  contact:
    name: example
channels: {}

Applies to AsyncAPI

Constraint

Type: Declarative Validation