Springwolf example project - Kafka

SpringKafkaDefaultHeaders-AnotherPayloadDto

Operation Binding

{
  "groupId": {
    "type": "string",
    "enum": [
      "example-group-id"
    ]
  },
  "bindingVersion": "0.5.0"
}

Message Binding

none

Headers

__TypeId__ string

Spring Type Id Header

Example:

{
  "__TypeId__": "io.github.springwolf.examples.kafka.dtos.AnotherPayloadDto"
}

Payload

AnotherPayloadDto

example*

foo string

Foo field

Example: bar <= 100 length

{
  "example": {
    "someEnum": "FOO2",
    "someLong": 5,
    "someString": "some string value"
  },
  "foo": "bar"
}

avro-topic

Channel Binding

AnotherPayloadAvroDto

kafka receive

Channelavro-topic

Operation description

Requires a running kafka-schema-registry. See docker-compose.yml to start it

Content-Typeapplication/json

Servers

Operation Binding

{
  "bindingVersion": "0.5.0"
}

Message Binding

none

Headers

HeadersNotDocumented

Payload

AnotherPayloadAvroDto

examplePayloadAvroDto

someEnum string

{
  "examplePayloadAvroDto": {
    "someLong": 0,
    "someString": "string"
  },
  "someEnum": "FOO1"
}

example-topic

Channel Binding

{
  "kafka": {
    "bindingVersion": "0.5.0"
  }
}

ExamplePayloadDto

kafka receive

Channelexample-topic

Content-Typeapplication/json

Servers

SpringKafkaDefaultHeaders-ExamplePayloadDto-1119017590

Operation Binding

{
  "bindingVersion": "0.5.0"
}

Message Binding

none

Headers

__TypeId__ string

Spring Type Id Header

Example:

kafka_offset integer Example: 0

kafka_receivedMessageKey string Example: "string"

kafka_recordMetadata object Example:

{
  "__TypeId__": "io.github.springwolf.examples.kafka.dtos.ExamplePayloadDto",
  "kafka_offset": 0,
  "kafka_receivedMessageKey": "string",
  "kafka_recordMetadata": {}
}

Payload

ExamplePayloadDto

someEnum* string

Some enum field

Example:

someLong integer (int64)

Some long field

Example: 5 >= 0 value range

someString* string

Some string field with Markdown

bold
cursive
images:

and code blocks (json, http, java)


{
  "key1":"value1",
  "key2":"value2"
}

Example: some string value

{
  "someEnum": "FOO2",
  "someLong": 5,
  "someString": "some string value"
}

integer-topic

Channel Binding

{
  "kafka": {
    "bindingVersion": "0.5.0"
  }
}

integer

kafka receive

Channelinteger-topic

Content-Typeapplication/json

Servers

SpringKafkaDefaultHeaders-integer

Operation Binding

{
  "bindingVersion": "0.5.0"
}

Message Binding

none

Headers

__TypeId__ string

Spring Type Id Header

Example:

{
  "__TypeId__": "java.lang.Integer"
}

Payload

Integer

multi-payload-topic

Channel Binding

AnotherPayloadDto

kafka receive

Channelmulti-payload-topic

Content-Typeapplication/json

Servers

SpringKafkaDefaultHeaders-AnotherPayloadDto

Operation Binding

{
  "bindingVersion": "0.5.0"
}

Message Binding

none

Headers

__TypeId__ string

Spring Type Id Header

Example:

{
  "__TypeId__": "io.github.springwolf.examples.kafka.dtos.AnotherPayloadDto"
}

Payload

AnotherPayloadDto

example*

foo string

Foo field

Example: bar <= 100 length

{
  "example": {
    "someEnum": "FOO2",
    "someLong": 5,
    "someString": "some string value"
  },
  "foo": "bar"
}

ExamplePayloadDto

kafka receive

Channelmulti-payload-topic

Content-Typeapplication/json

Servers

SpringKafkaDefaultHeaders-ExamplePayloadDto-1119017590

Operation Binding

{
  "bindingVersion": "0.5.0"
}

Message Binding

none

Headers

__TypeId__ string

Spring Type Id Header

Example:

kafka_offset integer Example: 0

kafka_receivedMessageKey string Example: "string"

kafka_recordMetadata object Example:

{
  "__TypeId__": "io.github.springwolf.examples.kafka.dtos.ExamplePayloadDto",
  "kafka_offset": 0,
  "kafka_receivedMessageKey": "string",
  "kafka_recordMetadata": {}
}

Payload

ExamplePayloadDto

someEnum* string

Some enum field

Example:

someLong integer (int64)

Some long field

Example: 5 >= 0 value range

someString* string

Some string field with Markdown

bold
cursive
images:

and code blocks (json, http, java)


{
  "key1":"value1",
  "key2":"value2"
}

Example: some string value

{
  "someEnum": "FOO2",
  "someLong": 5,
  "someString": "some string value"
}

MonetaryAmount

kafka receive

Channelmulti-payload-topic

Content-Typeapplication/json

Servers

SpringKafkaDefaultHeaders-MonetaryAmount

Operation Binding

{
  "bindingVersion": "0.5.0"
}

Message Binding

{
  "key": "example-key"
}

Headers

__TypeId__ string

Spring Type Id Header

Example:

{
  "__TypeId__": "javax.money.MonetaryAmount"
}

Payload

MonetaryAmount

amount number Example: 99.99 >= 0.01 value range

currency string Example: USD

{
  "amount": 99.99,
  "currency": "USD"
}

MonetaryAmount

kafka receive

Channelmulti-payload-topic

Operation description

Override description in the AsyncListener annotation with servers at kafka:29092

Content-Typeapplication/json

Servers

SpringKafkaDefaultHeaders-MonetaryAmount

Operation Binding

{
  "groupId": {
    "type": "string",
    "enum": [
      "foo-groupId"
    ]
  },
  "clientId": {
    "type": "string",
    "enum": [
      "foo-clientId"
    ]
  },
  "bindingVersion": "0.5.0"
}

Message Binding

{
  "key": "example-key"
}

Headers

__TypeId__ string

Spring Type Id Header

Example:

{
  "__TypeId__": "javax.money.MonetaryAmount"
}

Payload

MonetaryAmount

amount number Example: 99.99 >= 0.01 value range

currency string Example: USD

{
  "amount": 99.99,
  "currency": "USD"
}

no-payload-used-topic

Channel Binding

{
  "kafka": {
    "bindingVersion": "0.5.0"
  }
}

PayloadNotUsed

kafka receive

Channelno-payload-used-topic

Content-Typeapplication/json

Servers

SpringKafkaDefaultHeaders-PayloadNotUsed

Operation Binding

{
  "bindingVersion": "0.5.0"
}

Message Binding

none

Headers

__TypeId__ string

Spring Type Id Header

Example:

{
  "__TypeId__": "PayloadNotUsed"
}

Payload

PayloadNotUsed

protobuf-topic

Channel Binding

{
  "kafka": {
    "bindingVersion": "0.5.0"
  }
}

Message

kafka receive

Channelprotobuf-topic

Content-Typeapplication/json

Servers

SpringKafkaDefaultHeaders-Message

Operation Binding

{
  "bindingVersion": "0.5.0"
}

Message Binding

none

Headers

__TypeId__ string

Spring Type Id Header

Example:

{
  "__TypeId__": "io.github.springwolf.examples.kafka.dto.proto.ExamplePayloadProtobufDto$Message"
}

Payload

ExamplePayloadProtobufDto$Message

someEnum string

someLong integer (int64)

someString string

{
  "someEnum": "FOO1",
  "someLong": 0,
  "someString": "string"
}

string-topic

Channel Binding

string

kafka receive

Channelstring-topic

Operation description

Final classes (like String) can be documented using an envelope class and the @AsyncApiPayload annotation.

Content-Typeapplication/json

Servers

SpringKafkaDefaultHeaders-string

Operation Binding

{
  "bindingVersion": "0.5.0"
}

Message Binding

none

Headers

__TypeId__ string

Spring Type Id Header

Example:

{
  "__TypeId__": "java.lang.String"
}

Payload

String

StringEnvelope

kafka receive

Channelstring-topic

Operation description

Final classes (like String) can be documented using an envelope class and the @AsyncApiPayload annotation.

Content-Typeapplication/json

Servers

StringConsumer$StringEnvelope

Operation Binding

{
  "bindingVersion": "0.5.0"
}

Message Binding

none

Headers

HeadersNotUsed

Payload

string

Payload description using @Schema annotation and @AsyncApiPayload within envelope class

Example: "string" <= 100 length

topic-defined-via-asyncPublisher-annotation

Channel Binding

NestedPayloadDto

kafka send

Channeltopic-defined-via-asyncPublisher-annotation

Operation description

Custom, optional description defined in the AsyncPublisher annotation

Content-Typeapplication/json

Servers

SpringDefaultHeaderAndCloudEvent

Operation Binding

{
  "clientId": {
    "type": "string",
    "enum": [
      "foo-clientId"
    ]
  },
  "bindingVersion": "0.5.0"
}

Message Binding

{
  "key": "example-key"
}

Headers

__TypeId__ string

Spring Type Id Header

Example:

ce_id string

CloudEvent Id Header

Example:

ce_source string

CloudEvent Source Header

Example:

ce_specversion string

CloudEvent Spec Version Header

Example:

ce_subject string

CloudEvent Subject Header

Example:

ce_time string

CloudEvent Time Header

Example:

ce_type string

CloudEvent Payload Type Header

Example:

content-type string

CloudEvent Content-Type Header

Example:

{
  "__TypeId__": "io.github.springwolf.examples.kafka.dtos.NestedPayloadDto",
  "ce_id": "2c60089e-6f39-459d-8ced-2d6df7e4c03a",
  "ce_source": "http://localhost",
  "ce_specversion": "1.0",
  "ce_subject": "Springwolf example project - Kafka",
  "ce_time": "2023-10-28 20:01:23+00:00",
  "ce_type": "NestedPayloadDto.v1",
  "content-type": "application/json"
}

Payload

NestedPayloadDto

examplePayloads []

someStrings string[] Unique items: yes

{
  "examplePayloads": [
    {
      "someEnum": "FOO2",
      "someLong": 5,
      "someString": "some string value"
    }
  ],
  "someStrings": [
    "some string value"
  ]
}

vehicle-topic

Channel Binding

{
  "kafka": {
    "bindingVersion": "0.5.0"
  }
}

VehicleBase

kafka receive

Channelvehicle-topic

Content-Typeapplication/json

Servers

SpringKafkaDefaultHeaders-VehicleBase

Operation Binding

{
  "bindingVersion": "0.5.0"
}

Message Binding

none

Headers

__TypeId__ string

Spring Type Id Header

Example:

{
  "__TypeId__": "io.github.springwolf.examples.kafka.dtos.discriminator.VehicleBase"
}

Payload

VehicleBase

enginePower

powerSource string

topSpeed integer (int32)

vehicleType string

{
  "batteryCapacity": 0,
  "chargeTime": 0,
  "enginePower": {
    "hp": 0,
    "torque": 0
  },
  "powerSource": "string",
  "topSpeed": 0,
  "vehicleType": "string"
}

xml-topic

Channel Binding

XmlPayloadDto

kafka receive

Channelxml-topic

Operation description

Auto-generated description

Message description

Showcases a xml based message

Content-Typetext/xml

Servers

Operation Binding

{
  "bindingVersion": "0.5.0"
}

Message Binding

none

Headers

HeadersNotDocumented

Payload

XmlPayloadDto

string Example: <io.github.springwolf.examples.kafka.dtos.XmlPayloadDto someAttribute="string"><someEnum>FOO1</someEnum><someLong>0</someLong><someString>string</someString></io.github.springwolf.examples.kafka.dtos.XmlPayloadDto>

someAttribute string

someEnum string

someLong integer (int64)

someString string

<io.github.springwolf.examples.kafka.dtos.XmlPayloadDto someAttribute="string"><someEnum>FOO1</someEnum><someLong>0</someLong><someString>string</someString></io.github.springwolf.examples.kafka.dtos.XmlPayloadDto>

yaml-topic

Channel Binding

YamlPayloadDto

kafka receive

Channelyaml-topic

Operation description

Auto-generated description

Message description

Showcases a yaml based message

Content-Typeapplication/yaml

Servers

Operation Binding

{
  "bindingVersion": "0.5.0"
}

Message Binding

none

Headers

HeadersNotDocumented

Payload

YamlPayloadDto

string Example: someEnum: FOO1 someLong: 0 someString: string

someEnum string

someLong integer (int64)

someString string

someEnum: FOO1
someLong: 0
someString: string

Schemas

AnotherPayloadAvroDto

Nameio.github.springwolf.examples.kafka.dto.avro.AnotherPayloadAvroDto

Type

object

Used by

avro-topic

Example


{
  "examplePayloadAvroDto": {
    "someLong": 0,
    "someString": "string"
  },
  "someEnum": "FOO1"
}

Properties

examplePayloadAvroDto

someEnum string

AnotherPayloadDto

Nameio.github.springwolf.examples.kafka.dtos.AnotherPayloadDto

Type

object

Description

Another payload model

Used by

another-topic

Example


{
  "example": {
    "someEnum": "FOO2",
    "someLong": 5,
    "someString": "some string value"
  },
  "foo": "bar"
}

Properties

example*

foo string

Foo field

Example: bar <= 100 length

EnginePower

Nameio.github.springwolf.examples.kafka.dtos.discriminator.EnginePower

Type

object

Example


{
  "hp": 0,
  "torque": 0
}

Properties

hp integer (int32)

torque integer (int32)

ExamplePayloadAvroDto

Nameio.github.springwolf.examples.kafka.dto.avro.ExamplePayloadAvroDto

Type

object

Example


{
  "someLong": 0,
  "someString": "string"
}

Properties

someLong integer (int64)

someString string

ExamplePayloadDto

Nameio.github.springwolf.examples.kafka.dtos.ExamplePayloadDto

Type

object

Description

Example payload model demonstrating markdown text styling: bold, cursive and underlined

Used by

example-topic

Example


{
  "someEnum": "FOO2",
  "someLong": 5,
  "someString": "some string value"
}

Properties

someEnum* string

Some enum field

Example:

someLong integer (int64)

Some long field

Example: 5 >= 0 value range

someString* string

Some string field with Markdown

bold
cursive
images:

and code blocks (json, http, java)


{
  "key1":"value1",
  "key2":"value2"
}

Example: some string value

ExamplePayloadProtobufDto$Message

Nameio.github.springwolf.examples.kafka.dto.proto.ExamplePayloadProtobufDto$Message

Type

object

Used by

protobuf-topic

Example


{
  "someEnum": "FOO1",
  "someLong": 0,
  "someString": "string"
}

Properties

someEnum string

someLong integer (int64)

someString string

HeadersNotDocumented

NameHeadersNotDocumented

Type

object

Description

There can be headers, but they are not explicitly documented.

Used by

avro-topic

xml-topic

yaml-topic

Example

{}

Properties

HeadersNotUsed

NameHeadersNotUsed

Type

object

Description

No headers are present.

Used by

Example

{}

Properties

Integer

Namejava.lang.Integer

Type

integer

Used by

integer-topic

Example

Properties

integer (int32)Example: 0

MonetaryAmount

Namejavax.money.MonetaryAmount

Type

object

Used by

topic-defined-via-asyncPublisher-annotation

Example


{
  "amount": 99.99,
  "currency": "USD"
}

Properties

amount number Example: 99.99 >= 0.01 value range

currency string Example: USD

NestedPayloadDto

Nameio.github.springwolf.examples.kafka.dtos.NestedPayloadDto

Type

object

Description

Payload model with nested complex types

Used by

Example


{
  "examplePayloads": [
    {
      "someEnum": "FOO2",
      "someLong": 5,
      "someString": "some string value"
    }
  ],
  "someStrings": [
    "some string value"
  ]
}

Properties

examplePayloads []

someStrings string[] Unique items: yes

PayloadNotUsed

NamePayloadNotUsed

Type

object

Description

No payload specified

Used by

no-payload-used-topic

Example

{}

Properties

SpringDefaultHeaderAndCloudEvent

NameSpringDefaultHeaderAndCloudEvent

Type

object

Description

Spring TypeId and CloudEvent Headers

Used by

topic-defined-via-asyncPublisher-annotation

Example


{
  "__TypeId__": "io.github.springwolf.examples.kafka.dtos.NestedPayloadDto",
  "ce_id": "2c60089e-6f39-459d-8ced-2d6df7e4c03a",
  "ce_source": "http://localhost",
  "ce_specversion": "1.0",
  "ce_subject": "Springwolf example project - Kafka",
  "ce_time": "2023-10-28 20:01:23+00:00",
  "ce_type": "NestedPayloadDto.v1",
  "content-type": "application/json"
}

Properties

__TypeId__ string

Spring Type Id Header

Example:

ce_id string

CloudEvent Id Header

Example:

ce_source string

CloudEvent Source Header

Example:

ce_specversion string

CloudEvent Spec Version Header

Example:

ce_subject string

CloudEvent Subject Header

Example:

ce_time string

CloudEvent Time Header

Example:

ce_type string

CloudEvent Payload Type Header

Example:

content-type string

CloudEvent Content-Type Header

Example:

SpringKafkaDefaultHeaders-AnotherPayloadAvroDto

NameSpringKafkaDefaultHeaders-AnotherPayloadAvroDto

Type

object

Example


{
  "__TypeId__": "io.github.springwolf.examples.kafka.dto.avro.AnotherPayloadAvroDto"
}

Properties

__TypeId__ string

Spring Type Id Header

Example:

SpringKafkaDefaultHeaders-AnotherPayloadDto

NameSpringKafkaDefaultHeaders-AnotherPayloadDto

Type

object

Used by

another-topic

Example


{
  "__TypeId__": "io.github.springwolf.examples.kafka.dtos.AnotherPayloadDto"
}

Properties

__TypeId__ string

Spring Type Id Header

Example:

SpringKafkaDefaultHeaders-ExamplePayloadDto-1119017590

NameSpringKafkaDefaultHeaders-ExamplePayloadDto-1119017590

Type

object

Used by

example-topic

Example


{
  "__TypeId__": "io.github.springwolf.examples.kafka.dtos.ExamplePayloadDto",
  "kafka_offset": 0,
  "kafka_receivedMessageKey": "string",
  "kafka_recordMetadata": {}
}

Properties

__TypeId__ string

Spring Type Id Header

Example:

kafka_offset integer Example: 0

kafka_receivedMessageKey string Example: "string"

kafka_recordMetadata object Example:

SpringKafkaDefaultHeaders-integer

NameSpringKafkaDefaultHeaders-integer

Type

object

Used by

integer-topic

Example


{
  "__TypeId__": "java.lang.Integer"
}

Properties

__TypeId__ string

Spring Type Id Header

Example:

SpringKafkaDefaultHeaders-Message

NameSpringKafkaDefaultHeaders-Message

Type

object

Used by

protobuf-topic

Example


{
  "__TypeId__": "io.github.springwolf.examples.kafka.dto.proto.ExamplePayloadProtobufDto$Message"
}

Properties

__TypeId__ string

Spring Type Id Header

Example:

SpringKafkaDefaultHeaders-MonetaryAmount

NameSpringKafkaDefaultHeaders-MonetaryAmount

Type

object

Used by

Example


{
  "__TypeId__": "javax.money.MonetaryAmount"
}

Properties

__TypeId__ string

Spring Type Id Header

Example:

SpringKafkaDefaultHeaders-PayloadNotUsed

NameSpringKafkaDefaultHeaders-PayloadNotUsed

Type

object

Used by

no-payload-used-topic

Example


{
  "__TypeId__": "PayloadNotUsed"
}

Properties

__TypeId__ string

Spring Type Id Header

Example:

SpringKafkaDefaultHeaders-string

NameSpringKafkaDefaultHeaders-string

Type

object

Used by

Example


{
  "__TypeId__": "java.lang.String"
}

Properties

__TypeId__ string

Spring Type Id Header

Example:

SpringKafkaDefaultHeaders-VehicleBase

NameSpringKafkaDefaultHeaders-VehicleBase

Type

object

Used by

vehicle-topic

Example


{
  "__TypeId__": "io.github.springwolf.examples.kafka.dtos.discriminator.VehicleBase"
}

Properties

__TypeId__ string

Spring Type Id Header

Example:

SpringKafkaDefaultHeaders-XmlPayloadDto

NameSpringKafkaDefaultHeaders-XmlPayloadDto

Type

object

Example


{
  "__TypeId__": "io.github.springwolf.examples.kafka.dtos.XmlPayloadDto"
}

Properties

__TypeId__ string

Spring Type Id Header

Example:

SpringKafkaDefaultHeaders-YamlPayloadDto

NameSpringKafkaDefaultHeaders-YamlPayloadDto

Type

object

Example


{
  "__TypeId__": "io.github.springwolf.examples.kafka.dtos.YamlPayloadDto"
}

Properties

__TypeId__ string

Spring Type Id Header

Example:

String

Namejava.lang.String

Type

string

Used by

Example


"\"string\""

Properties

string Example: "string"

StringConsumer$StringEnvelope

Nameio.github.springwolf.examples.kafka.consumers.StringConsumer$StringEnvelope

Type

string

Description

Payload description using @Schema annotation and @AsyncApiPayload within envelope class

Used by