feat(kafka): add support for avro publishing (#1591)

timonback · web-flow · commit d4e93409b18d · 2026-01-16T16:49:47.000+01:00
diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/examples/walkers/json/ExampleJsonValueGenerator.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/examples/walkers/json/ExampleJsonValueGenerator.java
@@ -15,6 +15,7 @@
 import io.swagger.v3.oas.models.media.Schema;
 import jakarta.validation.constraints.NotNull;
 import lombok.extern.slf4j.Slf4j;
+import org.springframework.http.MediaType;
 
 import java.util.List;
 import java.util.Optional;
@@ -23,7 +24,8 @@
 @Slf4j
 public class ExampleJsonValueGenerator implements ExampleValueGenerator<JsonNode, JsonNode> {
 
-    private static final Set<String> SUPPORTED_CONTENT_TYPES = Set.of("application/json");
+    private static final Set<String> SUPPORTED_CONTENT_TYPES =
+            Set.of(MediaType.APPLICATION_JSON_VALUE, "application/avro");
 
     private static final YAMLMapper yamlMapper = YAMLMapper.builder().build();
 
diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/examples/walkers/xml/ExampleXmlValueGenerator.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/examples/walkers/xml/ExampleXmlValueGenerator.java
@@ -7,6 +7,7 @@
 import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.oas.models.media.StringSchema;
 import lombok.extern.slf4j.Slf4j;
+import org.springframework.http.MediaType;
 import org.w3c.dom.DOMException;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
@@ -32,7 +33,8 @@
 @Slf4j
 public class ExampleXmlValueGenerator implements ExampleValueGenerator<Node, String> {
 
-    private final Set<String> SUPPORTED_CONTENT_TYPES = Set.of("text/xml", "application/xml");
+    private final Set<String> SUPPORTED_CONTENT_TYPES =
+            Set.of(MediaType.TEXT_XML_VALUE, MediaType.APPLICATION_XML_VALUE);
     private final Schema<String> OVERRIDE_SCHEMA = new StringSchema();
 
     private final ExampleXmlValueSerializer exampleXmlValueSerializer;
diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/examples/walkers/yaml/ExampleYamlValueGenerator.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/examples/walkers/yaml/ExampleYamlValueGenerator.java
@@ -11,6 +11,7 @@
 import io.swagger.v3.oas.models.media.StringSchema;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
+import org.springframework.http.MediaType;
 
 import java.util.List;
 import java.util.Optional;
@@ -20,7 +21,7 @@
 @RequiredArgsConstructor
 public class ExampleYamlValueGenerator implements ExampleValueGenerator<JsonNode, String> {
 
-    private final Set<String> SUPPORTED_CONTENT_TYPES = Set.of("application/yaml");
+    private final Set<String> SUPPORTED_CONTENT_TYPES = Set.of(MediaType.APPLICATION_YAML_VALUE);
     private final Schema<String> OVERRIDE_SCHEMA = new StringSchema();
 
     private final ExampleJsonValueGenerator exampleJsonValueGenerator;
diff --git a/springwolf-examples/e2e/tests/publishing.spec.ts b/springwolf-examples/e2e/tests/publishing.spec.ts
@@ -65,7 +65,6 @@ function testPublishingEveryChannelItem() {
       const payloadName = messageName;
 
       if (
-        messageTitle === "AnotherPayloadAvroDto" || // Avro publishing is not supported
         messageTitle === "XmlPayloadDto" || // Unable to create correct xml payload
         messageTitle === "YamlPayloadDto" || // Unable to create correct yaml payload
         messageTitle === "MonetaryAmount" || // Issue with either MonetaryAmount of ModelConverters
diff --git a/springwolf-examples/springwolf-kafka-example/docker-compose.yml b/springwolf-examples/springwolf-kafka-example/docker-compose.yml
@@ -12,6 +12,7 @@ services:
       - "8080:8080"
     depends_on:
       - kafka
+      - kafka-schema-registry
 
   kafka:
     image: confluentinc/cp-kafka:8.1.1
@@ -40,8 +41,6 @@ services:
     image: confluentinc/cp-schema-registry:latest
     ports:
       - "8081:8081"
-    profiles:
-      - test # avoid starting (and pulling) this container by default
     environment:
       SCHEMA_REGISTRY_KAFKASTORE_BOOTSTRAP_SERVERS: kafka:29092
       SCHEMA_REGISTRY_HOST_NAME: kafka-schema-registry
diff --git a/springwolf-examples/springwolf-kafka-example/src/main/avro/ExamplePayloadAvroDto.avsc b/springwolf-examples/springwolf-kafka-example/src/main/avro/ExamplePayloadAvroDto.avsc
@@ -17,7 +17,7 @@
             "default": "FOO1"
         },
         {
-            "name": "ExamplePayloadAvroDto",
+            "name": "examplePayloadAvroDto",
             "type": {
                 "type": "record",
                 "name": "ExamplePayloadAvroDto",
diff --git a/springwolf-examples/springwolf-kafka-example/src/main/java/io/github/springwolf/examples/kafka/consumers/AvroConsumer.java b/springwolf-examples/springwolf-kafka-example/src/main/java/io/github/springwolf/examples/kafka/consumers/AvroConsumer.java
@@ -3,6 +3,7 @@
 
 import io.github.springwolf.bindings.kafka.annotations.KafkaAsyncOperationBinding;
 import io.github.springwolf.core.asyncapi.annotations.AsyncListener;
+import io.github.springwolf.core.asyncapi.annotations.AsyncMessage;
 import io.github.springwolf.core.asyncapi.annotations.AsyncOperation;
 import io.github.springwolf.examples.kafka.dto.avro.AnotherPayloadAvroDto;
 import lombok.RequiredArgsConstructor;
@@ -29,7 +30,8 @@ public class AvroConsumer {
                     @AsyncOperation(
                             channelName = "avro-topic",
                             description =
-                                    "Requires a running kafka-schema-registry. See docker-compose.yml to start it"))
+                                    "Requires a running kafka-schema-registry. See docker-compose.yml to start it",
+                            message = @AsyncMessage(contentType = "application/avro")))
     @KafkaAsyncOperationBinding
     public void receiveExampleAvroPayload(AnotherPayloadAvroDto payloads) {
         log.debug("Received new message in avro-topic: {}", payloads.toString());
diff --git a/springwolf-examples/springwolf-kafka-example/src/test/java/io/github/springwolf/examples/kafka/KafkaProducerSystemTest.java b/springwolf-examples/springwolf-kafka-example/src/test/java/io/github/springwolf/examples/kafka/KafkaProducerSystemTest.java
@@ -5,7 +5,6 @@
 import io.github.springwolf.examples.kafka.dtos.ExamplePayloadDto;
 import lombok.extern.slf4j.Slf4j;
 import org.awaitility.Awaitility;
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.condition.DisabledIf;
 import org.springframework.http.HttpEntity;
@@ -39,7 +38,7 @@ public class KafkaProducerSystemTest {
     private static final String KAFKA_NAME = "kafka";
     private static final String topic = "example-topic";
 
-    private static final boolean USE_SCHEMA_REGISTRY = false;
+    private static final boolean USE_SCHEMA_REGISTRY = true;
 
     @Container
     public static ComposeContainer environment = new ComposeContainer(new File("docker-compose.yml"))
@@ -98,7 +97,6 @@ void producerCanUseSpringwolfConfigurationToSendMessage() throws Exception {
     }
 
     @Test
-    @Disabled("Publishing AVRO is not supported")
     @DisabledIf(
             value = "withoutSchemaRegistry",
             disabledReason = "because it requires a running kafka-schema-registry instance (docker image= ~1GB).")
@@ -108,7 +106,7 @@ void producerCanUseSpringwolfConfigurationToSendAvroMessage() throws Exception {
         headers.put("Content-Type", List.of("application/json"));
 
         String payloadAsString =
-                "{\"someEnum\": \"FOO1\", \"ExamplePayloadAvroDto\": {\"someString\": \"string\", \"someLong\": 0}}";
+                "{\"someEnum\": \"FOO1\", \"examplePayloadAvroDto\": {\"someString\": \"string\", \"someLong\": 0}}";
         String message = "{\n" //
                 + "    \"bindings\": {},\n"
                 + "    \"headers\": {},\n"
diff --git a/springwolf-examples/springwolf-kafka-example/src/test/resources/asyncapi.json b/springwolf-examples/springwolf-kafka-example/src/test/resources/asyncapi.json
@@ -1961,6 +1961,7 @@
             "$ref": "#/components/schemas/io.github.springwolf.examples.kafka.dto.avro.AnotherPayloadAvroDto"
           }
         },
+        "contentType": "application/avro",
         "name": "io.github.springwolf.examples.kafka.dto.avro.AnotherPayloadAvroDto",
         "title": "AnotherPayloadAvroDto",
         "bindings": {
diff --git a/springwolf-examples/springwolf-kafka-example/src/test/resources/asyncapi.openapiv31.json b/springwolf-examples/springwolf-kafka-example/src/test/resources/asyncapi.openapiv31.json
@@ -1180,6 +1180,7 @@
             "$ref": "#/components/schemas/io.github.springwolf.examples.kafka.dto.avro.AnotherPayloadAvroDto"
           }
         },
+        "contentType": "application/avro",
         "name": "io.github.springwolf.examples.kafka.dto.avro.AnotherPayloadAvroDto",
         "title": "AnotherPayloadAvroDto",
         "bindings": {
diff --git a/springwolf-examples/springwolf-kafka-example/src/test/resources/asyncapi.yaml b/springwolf-examples/springwolf-kafka-example/src/test/resources/asyncapi.yaml
@@ -1422,6 +1422,7 @@ components:
         schemaFormat: application/vnd.aai.asyncapi+json;version=3.0.0
         schema:
           $ref: "#/components/schemas/io.github.springwolf.examples.kafka.dto.avro.AnotherPayloadAvroDto"
+      contentType: application/avro
       name: io.github.springwolf.examples.kafka.dto.avro.AnotherPayloadAvroDto
       title: AnotherPayloadAvroDto
       bindings:
diff --git a/springwolf-ui/src/app/components/channels/channel-operation/channel-operation.component.html b/springwolf-ui/src/app/components/channels/channel-operation/channel-operation.component.html
@@ -154,7 +154,7 @@ <h6>Payload</h6>
   <div class="width-6-of-12 width-12-of-12-s">
     <app-prism-editor
       [(code)]="defaultExample().value"
-      [language]="exampleContentType()"
+      [language]="exampleLanguage()"
     />
 
     <div class="flex space-between">
diff --git a/springwolf-ui/src/app/components/channels/channel-operation/channel-operation.component.ts b/springwolf-ui/src/app/components/channels/channel-operation/channel-operation.component.ts
@@ -47,9 +47,13 @@ export class ChannelOperationComponent implements OnInit {
   defaultSchema = signal<Schema>(initSchema);
   defaultExample = signal<Example>(initExample);
   originalDefaultExample = signal<Example>(initExample);
-  exampleContentType = computed(
-    () => this.operation().message.contentType.split("/").pop() || "json"
-  );
+  exampleLanguage = computed(() => {
+    const contentType = this.operation().message.contentType;
+    if (contentType.includes("avro")) {
+      return "json";
+    }
+    return contentType.split("/").pop() || "json";
+  });
 
   headers = signal<Schema>(initSchema);
   headersExample = initExample;

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`"default": "FOO1"`
`18`	`18`	`},`
`19`	`19`	`{`
`20`		`- "name": "ExamplePayloadAvroDto",`
	`20`	`+ "name": "examplePayloadAvroDto",`
`21`	`21`	`"type": {`
`22`	`22`	`"type": "record",`
`23`	`23`	`"name": "ExamplePayloadAvroDto",`
Original file line number	Diff line number	Diff line change
`@@ -1961,6 +1961,7 @@`
`1961`	`1961`	`"$ref": "#/components/schemas/io.github.springwolf.examples.kafka.dto.avro.AnotherPayloadAvroDto"`
`1962`	`1962`	`}`
`1963`	`1963`	`},`
	`1964`	`+ "contentType": "application/avro",`
`1964`	`1965`	`"name": "io.github.springwolf.examples.kafka.dto.avro.AnotherPayloadAvroDto",`
`1965`	`1966`	`"title": "AnotherPayloadAvroDto",`
`1966`	`1967`	`"bindings": {`
Original file line number	Diff line number	Diff line change
`@@ -1180,6 +1180,7 @@`
`1180`	`1180`	`"$ref": "#/components/schemas/io.github.springwolf.examples.kafka.dto.avro.AnotherPayloadAvroDto"`
`1181`	`1181`	`}`
`1182`	`1182`	`},`
	`1183`	`+ "contentType": "application/avro",`
`1183`	`1184`	`"name": "io.github.springwolf.examples.kafka.dto.avro.AnotherPayloadAvroDto",`
`1184`	`1185`	`"title": "AnotherPayloadAvroDto",`
`1185`	`1186`	`"bindings": {`