Adapt springwolf-kafka-example to the new annotation structure, to contain an example for the key and to the change that a kafka message binding is always present

Author: sam0r040

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

@@ -14,7 +14,6 @@
 
 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.converter.AbstractJavaTypeMapper.DEFAULT_CLASSID_FIELD_NAME;
 
 
@@ -54,9 +53,11 @@ public void receiveAnotherPayload(AnotherPayloadDto payload) {
             clientId = "foo-clientId",
             groupId = "#{'foo-groupId'}",
             messageBinding = @KafkaAsyncMessageBinding(
-                    keyType = STRING_KEY,
-                    bindingVersion = "1",
-                    description = "Kafka Consumer Message Key"
+                    key = @KafkaAsyncOperationBinding.KafkaAsyncKey(
+                            description = "Kafka Consumer Message Key",
+                            example = "example-key"
+                    ),
+                    bindingVersion = "1"
             )
     )
     public void receiveMonetaryAmount(MonetaryAmount payload) {

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

@@ -3,13 +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.KafkaAsyncKey;
 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.converter.AbstractJavaTypeMapper.DEFAULT_CLASSID_FIELD_NAME;
 
@@ -42,9 +42,11 @@ public class ExampleProducer {
             bindingVersion = "1",
             clientId = "foo-clientId",
             messageBinding = @KafkaAsyncMessageBinding(
-                    keyType = STRING_KEY,
-                    bindingVersion = "1",
-                    description = "Kafka Producer Message Key"
+                    key = @KafkaAsyncKey(
+                            description = "Kafka Producer Message Key",
+                            example = "example-key"
+                    ),
+                    bindingVersion = "1"
             )
     )
     public void sendMessage(ExamplePayloadDto msg) {

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

@@ -63,6 +63,9 @@
           },
           "headers" : {
             "$ref" : "#/components/schemas/HeadersNotDocumented"
+          },
+          "bindings" : {
+            "kafka" : { }
           }
         }
       },
@@ -87,6 +90,9 @@
             },
             "headers" : {
               "$ref" : "#/components/schemas/CloudEventHeadersForAnotherPayloadDtoEndpoint"
+            },
+            "bindings" : {
+              "kafka" : { }
             }
           }, {
             "name" : "io.github.stavshamir.springwolf.example.dtos.ExamplePayloadDto",
@@ -97,6 +103,17 @@
             },
             "headers" : {
               "$ref" : "#/components/schemas/SpringKafkaDefaultHeaders"
+            },
+            "bindings" : {
+              "kafka" : {
+                "key" : {
+                  "type" : "string",
+                  "description" : "Kafka Producer Message Key",
+                  "example" : "example-key",
+                  "exampleSetFlag" : true,
+                  "types" : [ "string" ]
+                }
+              }
             }
           } ]
         }
@@ -120,6 +137,9 @@
           },
           "headers" : {
             "$ref" : "#/components/schemas/HeadersNotDocumented"
+          },
+          "bindings" : {
+            "kafka" : { }
           }
         }
       },
@@ -148,6 +168,9 @@
             },
             "headers" : {
               "$ref" : "#/components/schemas/SpringKafkaDefaultHeaders-AnotherPayloadDto"
+            },
+            "bindings" : {
+              "kafka" : { }
             }
           }, {
             "name" : "io.github.stavshamir.springwolf.example.dtos.ExamplePayloadDto",
@@ -157,6 +180,9 @@
             },
             "headers" : {
               "$ref" : "#/components/schemas/SpringKafkaDefaultHeaders-ExamplePayloadDto"
+            },
+            "bindings" : {
+              "kafka" : { }
             }
           }, {
             "name" : "javax.money.MonetaryAmount",
@@ -173,7 +199,8 @@
                 "key" : {
                   "type" : "string",
                   "description" : "Kafka Consumer Message Key",
-                  "exampleSetFlag" : false,
+                  "example" : "example-key",
+                  "exampleSetFlag" : true,
                   "types" : [ "string" ]
                 },
                 "bindingVersion" : "1"