kafka

Kafka Bindings

This document defines how to describe Kafka-specific information on AsyncAPI.

Version

Current version is 0.2.0.

Server Binding Object

This object MUST NOT contain any properties. Its name is reserved for future use.

Channel Binding Object

This object MUST NOT contain any properties. Its name is reserved for future use.

Operation Binding Object

This object contains information about the operation representation in Kafka.

Fixed Fields

Field Name	Type	Description
groupId	Schema Object	Id of the consumer group.
clientId	Schema Object	Id of the consumer inside a consumer group.
bindingVersion	string	The version of this binding. If omitted, "latest" MUST be assumed.

This object MUST contain only the properties defined above.

Example

channels:
  user-signedup:
    publish:
      bindings:
        kafka:
          groupId:
            type: string
            enum: ['myGroupId']
          clientId:
            type: string
            enum: ['myClientId']
          bindingVersion: '0.1.0'

Message Binding Object

This object contains information about the message representation in Kafka.

Fixed Fields

Field Name	Type	Description
key	Schema Object | AVRO Schema Object	The message key. NOTE: You can also use the reference object way.
bindingVersion	string	The version of this binding. If omitted, "latest" MUST be assumed.

This object MUST contain only the properties defined above.

channels:
  test:
    publish:
      message:
        bindings:
          kafka:
            key:
              type: string
              enum: ['myKey']
            bindingVersion: '0.1.0'