Extend springwolf-kafka-example to include documentation of kafka keys as message binding by using annotations

Author: sam0r040

springwolf-examples/springwolf-kafka-example/src/main/java/io/github/stavshamir/springwolf/example/consumers/ExampleClassLevelKafkaListener.java

@@ -3,6 +3,7 @@
 import io.github.stavshamir.springwolf.asyncapi.scanners.channels.operationdata.annotation.AsyncOperation;
 import io.github.stavshamir.springwolf.asyncapi.scanners.channels.operationdata.annotation.AsyncListener;
 import io.github.stavshamir.springwolf.asyncapi.scanners.channels.operationdata.annotation.KafkaAsyncOperationBinding;
+import io.github.stavshamir.springwolf.asyncapi.scanners.channels.operationdata.annotation.KafkaAsyncOperationBinding.KafkaAsyncMessageBinding;
 import io.github.stavshamir.springwolf.example.dtos.AnotherPayloadDto;
 import io.github.stavshamir.springwolf.example.dtos.ExamplePayloadDto;
 import lombok.extern.slf4j.Slf4j;
@@ -12,6 +13,7 @@
 
 import javax.money.MonetaryAmount;
 
+import static io.github.stavshamir.springwolf.asyncapi.scanners.channels.operationdata.annotation.KafkaAsyncOperationBinding.KafkaAsyncMessageBinding.KafkaKeyTypes.STRING_KEY;
 import static org.springframework.kafka.support.mapping.AbstractJavaTypeMapper.DEFAULT_CLASSID_FIELD_NAME;
 
 
@@ -48,7 +50,12 @@ public void receiveAnotherPayload(AnotherPayloadDto payload) {
     @KafkaAsyncOperationBinding(
             bindingVersion = "1",
             clientId = "foo-clientId",
-            groupId = "#{'foo-groupId'}"
+            groupId = "#{'foo-groupId'}",
+            messageBinding = @KafkaAsyncMessageBinding(
+                    keyType = STRING_KEY,
+                    bindingVersion = "1",
+                    description = "Kafka Consumer Message Key"
+            )
     )
     public void receiveMonetaryAmount(MonetaryAmount payload) {
         log.info("Received new message in multi-payload-topic: {}", payload.toString());

springwolf-examples/springwolf-kafka-example/src/main/java/io/github/stavshamir/springwolf/example/producers/ExampleProducer.java

@@ -3,11 +3,13 @@
 import io.github.stavshamir.springwolf.asyncapi.scanners.channels.operationdata.annotation.AsyncOperation;
 import io.github.stavshamir.springwolf.asyncapi.scanners.channels.operationdata.annotation.AsyncPublisher;
 import io.github.stavshamir.springwolf.asyncapi.scanners.channels.operationdata.annotation.KafkaAsyncOperationBinding;
+import io.github.stavshamir.springwolf.asyncapi.scanners.channels.operationdata.annotation.KafkaAsyncOperationBinding.KafkaAsyncMessageBinding;
 import io.github.stavshamir.springwolf.example.dtos.ExamplePayloadDto;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.kafka.core.KafkaTemplate;
 import org.springframework.stereotype.Component;
 
+import static io.github.stavshamir.springwolf.asyncapi.scanners.channels.operationdata.annotation.KafkaAsyncOperationBinding.KafkaAsyncMessageBinding.KafkaKeyTypes.STRING_KEY;
 import static io.github.stavshamir.springwolf.example.configuration.KafkaConfiguration.PRODUCER_TOPIC;
 import static org.springframework.kafka.support.mapping.AbstractJavaTypeMapper.DEFAULT_CLASSID_FIELD_NAME;
 
@@ -38,7 +40,12 @@ public class ExampleProducer {
     ))
     @KafkaAsyncOperationBinding(
             bindingVersion = "1",
-            clientId = "foo-clientId"
+            clientId = "foo-clientId",
+            messageBinding = @KafkaAsyncMessageBinding(
+                    keyType = STRING_KEY,
+                    bindingVersion = "1",
+                    description = "Kafka Producer Message Key"
+            )
     )
     public void sendMessage(ExamplePayloadDto msg) {
         kafkaTemplate.send(PRODUCER_TOPIC, msg);

springwolf-examples/springwolf-kafka-example/src/test/resources/asyncapi.json

@@ -167,6 +167,17 @@
             },
             "headers" : {
               "$ref" : "#/components/schemas/SpringKafkaDefaultHeaders-MonetaryAmount"
+            },
+            "bindings" : {
+              "kafka" : {
+                "key" : {
+                  "type" : "string",
+                  "description" : "Kafka Consumer Message Key",
+                  "exampleSetFlag" : false,
+                  "types" : [ "string" ]
+                },
+                "bindingVersion" : "1"
+              }
             }
           } ]
         }
@@ -414,4 +425,4 @@
     }
   },
   "tags" : [ ]
-}
+}