Add specialized ProducerData classes for Kafka and AMQP

stavshamir · stavshamir · commit 471ebdb08d07 · 2022-06-06T21:23:42.000+03:00
diff --git a/springwolf-core/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/ProducerData.java b/springwolf-core/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/ProducerData.java
@@ -19,7 +19,7 @@ public class ProducerData {
     /**
      * The name of the channel (topic, queue etc.).
      */
-    private String channelName;
+    protected String channelName;
 
     /**
      * The channel binding of the producer.
@@ -29,12 +29,12 @@ public class ProducerData {
      *     ImmutableMap.of("kafka", new KafkaChannelBinding())
      * </code>
      */
-    private Map<String, ? extends ChannelBinding> channelBinding;
+    protected Map<String, ? extends ChannelBinding> channelBinding;
 
     /**
      * The class object of the payload published by this producer.
      */
-    private Class<?> payloadType;
+    protected Class<?> payloadType;
 
     /**
      * The operation binding of the producer.
@@ -44,6 +44,6 @@ public class ProducerData {
      *     ImmutableMap.of("kafka", new KafkaOperationBinding())
      * </code>
      */
-    private Map<String, ? extends OperationBinding> operationBinding;
+    protected Map<String, ? extends OperationBinding> operationBinding;
 
 }
diff --git a/springwolf-examples/springwolf-amqp-example/build.gradle b/springwolf-examples/springwolf-amqp-example/build.gradle
@@ -7,7 +7,7 @@ plugins {
 }
 
 sourceCompatibility = '1.8'
-version '0.2.0'
+version '0.3.0'
 
 repositories {
     // For local development with snapshots
diff --git a/springwolf-examples/springwolf-amqp-example/docker-compose.yml b/springwolf-examples/springwolf-amqp-example/docker-compose.yml
@@ -1,7 +1,7 @@
 version: '3'
 services:
   app:
-    image: stavshamir/springwolf-amqp-example:0.2.0
+    image: stavshamir/springwolf-amqp-example:0.3.0
     links:
       - amqp
     ports:
diff --git a/springwolf-examples/springwolf-amqp-example/src/main/java/io/github/stavshamir/springwolf/example/configuration/AsyncApiConfiguration.java b/springwolf-examples/springwolf-amqp-example/src/main/java/io/github/stavshamir/springwolf/example/configuration/AsyncApiConfiguration.java
@@ -1,20 +1,15 @@
 package io.github.stavshamir.springwolf.example.configuration;
 
-import com.asyncapi.v2.binding.amqp.AMQPChannelBinding;
-import com.asyncapi.v2.binding.amqp.AMQPOperationBinding;
 import com.asyncapi.v2.model.info.Info;
 import com.asyncapi.v2.model.server.Server;
-import com.google.common.collect.ImmutableMap;
-import io.github.stavshamir.springwolf.asyncapi.types.ProducerData;
+import io.github.stavshamir.springwolf.asyncapi.types.AmqpProducerData;
 import io.github.stavshamir.springwolf.configuration.AsyncApiDocket;
 import io.github.stavshamir.springwolf.configuration.EnableAsyncApi;
 import io.github.stavshamir.springwolf.example.dtos.AnotherPayloadDto;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
-import java.util.Collections;
-
 @Configuration
 @EnableAsyncApi
 public class AsyncApiConfiguration {
@@ -41,18 +36,11 @@ public AsyncApiDocket asyncApiDocket() {
                 .url(String.format("%s:%s", amqpHost, amqpPort))
                 .build();
 
-        AMQPChannelBinding.ExchangeProperties exchangeProperties = new AMQPChannelBinding.ExchangeProperties();
-        exchangeProperties.setName("example-topic-exchange");
-        ProducerData exampleProducer = ProducerData.builder()
-                .channelName("example-producer-channel")
-                .channelBinding(ImmutableMap.of("amqp", AMQPChannelBinding.builder()
-                        .is("routingKey")
-                        .exchange(exchangeProperties)
-                        .build()))
+        AmqpProducerData exampleProducer = AmqpProducerData.amqpProducerDataBuilder()
+                .queueName("example-producer-channel")
+                .exchangeName("example-topic-exchange")
+                .routingKey("example-topic-routing-key")
                 .payloadType(AnotherPayloadDto.class)
-                .operationBinding(ImmutableMap.of("amqp", AMQPOperationBinding.builder()
-                        .cc(Collections.singletonList("example-topic-routing-key"))
-                        .build()))
                 .build();
 
         return AsyncApiDocket.builder()
diff --git a/springwolf-examples/springwolf-kafka-example/build.gradle b/springwolf-examples/springwolf-kafka-example/build.gradle
@@ -7,7 +7,7 @@ plugins {
 }
 
 sourceCompatibility = '1.8'
-version '0.5.0'
+version '0.6.0'
 
 
 repositories {
diff --git a/springwolf-examples/springwolf-kafka-example/docker-compose.yml b/springwolf-examples/springwolf-kafka-example/docker-compose.yml
@@ -1,7 +1,7 @@
 version: '3'
 services:
   app:
-    image: stavshamir/springwolf-kafka-example:0.5.0
+    image: stavshamir/springwolf-kafka-example:0.6.0
     links:
       - kafka
     environment:
diff --git a/springwolf-examples/springwolf-kafka-example/src/main/java/io/github/stavshamir/springwolf/example/configuration/AsyncApiConfiguration.java b/springwolf-examples/springwolf-kafka-example/src/main/java/io/github/stavshamir/springwolf/example/configuration/AsyncApiConfiguration.java
@@ -1,10 +1,8 @@
 package io.github.stavshamir.springwolf.example.configuration;
 
-import com.asyncapi.v2.binding.kafka.KafkaOperationBinding;
 import com.asyncapi.v2.model.info.Info;
 import com.asyncapi.v2.model.server.Server;
-import com.google.common.collect.ImmutableMap;
-import io.github.stavshamir.springwolf.asyncapi.types.ProducerData;
+import io.github.stavshamir.springwolf.asyncapi.types.KafkaProducerData;
 import io.github.stavshamir.springwolf.configuration.AsyncApiDocket;
 import io.github.stavshamir.springwolf.configuration.EnableAsyncApi;
 import io.github.stavshamir.springwolf.example.dtos.AnotherPayloadDto;
@@ -32,8 +30,15 @@ public AsyncApiDocket asyncApiDocket() {
                 .title("Springwolf example project")
                 .build();
 
-        ProducerData exampleProducerData = buildKafkaProducerData(PRODUCER_TOPIC, ExamplePayloadDto.class);
-        ProducerData anotherProducerData = buildKafkaProducerData(PRODUCER_TOPIC, AnotherPayloadDto.class);
+        KafkaProducerData exampleProducerData = KafkaProducerData.kafkaProducerDataBuilder()
+                .topicName(PRODUCER_TOPIC)
+                .payloadType(ExamplePayloadDto.class)
+                .build();
+
+        KafkaProducerData anotherProducerData = KafkaProducerData.kafkaProducerDataBuilder()
+                .topicName(PRODUCER_TOPIC)
+                .payloadType(AnotherPayloadDto.class)
+                .build();
 
         return AsyncApiDocket.builder()
                 .basePackage("io.github.stavshamir.springwolf.example.consumers")
@@ -44,12 +49,4 @@ public AsyncApiDocket asyncApiDocket() {
                 .build();
     }
 
-    private ProducerData buildKafkaProducerData(String topic, Class<?> payload) {
-        return ProducerData.builder()
-                .channelName(topic)
-                .operationBinding(ImmutableMap.of("kafka", new KafkaOperationBinding()))
-                .payloadType(payload)
-                .build();
-    }
-
 }
diff --git a/springwolf-examples/springwolf-kafka-example/src/test/resources/asyncapi.json b/springwolf-examples/springwolf-kafka-example/src/test/resources/asyncapi.json
@@ -13,9 +13,6 @@
     },
     "channels": {
       "another-topic": {
-        "bindings": {
-          "kafka": {}
-        },
         "publish": {
           "bindings": {
             "kafka": {
@@ -34,12 +31,12 @@
               "$ref": "#/components/schemas/AnotherPayloadDto"
             }
           }
+        },
+        "bindings": {
+          "kafka": {}
         }
       },
       "example-topic": {
-        "bindings": {
-          "kafka": {}
-        },
         "publish": {
           "bindings": {
             "kafka": {}
@@ -51,13 +48,13 @@
               "$ref": "#/components/schemas/ExamplePayloadDto"
             }
           }
-        }
-      },
-      "multi-payload-topic": {
+        },
         "bindings": {
           "kafka": {}
-        },
-        "publish": {
+        }
+      },
+      "example-producer-topic": {
+        "subscribe": {
           "bindings": {
             "kafka": {}
           },
@@ -79,10 +76,13 @@
               }
             ]
           }
+        },
+        "bindings": {
+          "kafka": {}
         }
       },
-      "example-producer-topic": {
-        "subscribe": {
+      "multi-payload-topic": {
+        "publish": {
           "bindings": {
             "kafka": {}
           },
@@ -104,6 +104,9 @@
               }
             ]
           }
+        },
+        "bindings": {
+          "kafka": {}
         }
       }
     },
@@ -156,4 +159,4 @@
       }
     }
   }
-}
+}
diff --git a/springwolf-plugins/springwolf-amqp-plugin/README.md b/springwolf-plugins/springwolf-amqp-plugin/README.md
@@ -24,10 +24,10 @@ Add the following dependencies and configuration class to enable this plugin.
 ```groovy
 dependencies {
     // Provides the documentation API    
-    implementation 'io.github.springwolf:springwolf-amqp:0.2.0'
+    implementation 'io.github.springwolf:springwolf-amqp:0.3.0'
 
     // Provides the UI - optional (recommended)
-    runtimeOnly 'io.github.springwolf:springwolf-ui:0.3.1'
+    runtimeOnly 'io.github.springwolf:springwolf-ui:0.4.0'
 }
 ```
 
diff --git a/springwolf-plugins/springwolf-amqp-plugin/build.gradle b/springwolf-plugins/springwolf-amqp-plugin/build.gradle
@@ -9,7 +9,7 @@ plugins {
 }
 
 group 'io.github.springwolf'
-version '0.2.0'
+version '0.3.0'
 sourceCompatibility = 1.8
 
 repositories {
diff --git a/springwolf-plugins/springwolf-amqp-plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/AmqpProducerData.java b/springwolf-plugins/springwolf-amqp-plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/AmqpProducerData.java
@@ -0,0 +1,30 @@
+package io.github.stavshamir.springwolf.asyncapi.types;
+
+import com.asyncapi.v2.binding.amqp.AMQPChannelBinding;
+import com.asyncapi.v2.binding.amqp.AMQPOperationBinding;
+import com.google.common.collect.ImmutableMap;
+import lombok.Builder;
+
+import java.util.Collections;
+
+public class AmqpProducerData extends ProducerData {
+
+    @Builder(builderMethodName = "amqpProducerDataBuilder")
+    public AmqpProducerData(String queueName, String exchangeName, String routingKey, Class<?> payloadType) {
+        this.channelName = queueName;
+
+        AMQPChannelBinding.ExchangeProperties exchangeProperties = new AMQPChannelBinding.ExchangeProperties();
+        exchangeProperties.setName(exchangeName);
+        this.channelBinding = ImmutableMap.of("amqp", AMQPChannelBinding.builder()
+                .is("routingKey")
+                .exchange(exchangeProperties)
+                .build());
+
+        this.operationBinding = ImmutableMap.of("amqp", AMQPOperationBinding.builder()
+                .cc(Collections.singletonList(routingKey))
+                .build());
+
+        this.payloadType = payloadType;
+    }
+
+}
diff --git a/springwolf-plugins/springwolf-kafka-plugin/README.md b/springwolf-plugins/springwolf-kafka-plugin/README.md
@@ -26,7 +26,7 @@ Add the following dependencies and configuration class to enable this plugin.
 ```groovy
 dependencies {
     // Provides the documentation API    
-    implementation 'io.github.springwolf:springwolf-kafka:0.5.0'
+    implementation 'io.github.springwolf:springwolf-kafka:0.6.0'
 
     // Provides the UI - optional (recommended)
     runtimeOnly 'io.github.springwolf:springwolf-ui:0.4.0'
diff --git a/springwolf-plugins/springwolf-kafka-plugin/build.gradle b/springwolf-plugins/springwolf-kafka-plugin/build.gradle
@@ -9,7 +9,7 @@ plugins {
 }
 
 group 'io.github.springwolf'
-version '0.5.0'
+version '0.6.0'
 sourceCompatibility = 1.8
 
 repositories {
diff --git a/springwolf-plugins/springwolf-kafka-plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/KafkaProducerData.java b/springwolf-plugins/springwolf-kafka-plugin/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/KafkaProducerData.java
@@ -0,0 +1,18 @@
+package io.github.stavshamir.springwolf.asyncapi.types;
+
+import com.asyncapi.v2.binding.kafka.KafkaChannelBinding;
+import com.asyncapi.v2.binding.kafka.KafkaOperationBinding;
+import com.google.common.collect.ImmutableMap;
+import lombok.Builder;
+
+public class KafkaProducerData extends ProducerData {
+
+    @Builder(builderMethodName = "kafkaProducerDataBuilder")
+    public KafkaProducerData(String topicName, Class<?> payloadType) {
+        this.channelName = topicName;
+        this.channelBinding = ImmutableMap.of("kafka", new KafkaChannelBinding());
+        this.payloadType = payloadType;
+        this.operationBinding = ImmutableMap.of("kafka", new KafkaOperationBinding());
+    }
+
+}

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ plugins {`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`sourceCompatibility = '1.8'`
`10`		`-version '0.2.0'`
	`10`	`+version '0.3.0'`
`11`	`11`
`12`	`12`	`repositories {`
`13`	`13`	`// For local development with snapshots`
Original file line number	Diff line number	Diff line change
`@@ -13,9 +13,6 @@`
`13`	`13`	`},`
`14`	`14`	`"channels": {`
`15`	`15`	`"another-topic": {`
`16`		`- "bindings": {`
`17`		`- "kafka": {}`
`18`		`- },`
`19`	`16`	`"publish": {`
`20`	`17`	`"bindings": {`
`21`	`18`	`"kafka": {`
`@@ -34,12 +31,12 @@`
`34`	`31`	`"$ref": "#/components/schemas/AnotherPayloadDto"`
`35`	`32`	`}`
`36`	`33`	`}`
	`34`	`+ },`
	`35`	`+ "bindings": {`
	`36`	`+ "kafka": {}`
`37`	`37`	`}`
`38`	`38`	`},`
`39`	`39`	`"example-topic": {`
`40`		`- "bindings": {`
`41`		`- "kafka": {}`
`42`		`- },`
`43`	`40`	`"publish": {`
`44`	`41`	`"bindings": {`
`45`	`42`	`"kafka": {}`
`@@ -51,13 +48,13 @@`
`51`	`48`	`"$ref": "#/components/schemas/ExamplePayloadDto"`
`52`	`49`	`}`
`53`	`50`	`}`
`54`		`- }`
`55`		`- },`
`56`		`- "multi-payload-topic": {`
	`51`	`+ },`
`57`	`52`	`"bindings": {`
`58`	`53`	`"kafka": {}`
`59`		`- },`
`60`		`- "publish": {`
	`54`	`+ }`
	`55`	`+ },`
	`56`	`+ "example-producer-topic": {`
	`57`	`+ "subscribe": {`
`61`	`58`	`"bindings": {`
`62`	`59`	`"kafka": {}`
`63`	`60`	`},`
`@@ -79,10 +76,13 @@`
`79`	`76`	`}`
`80`	`77`	`]`
`81`	`78`	`}`
	`79`	`+ },`
	`80`	`+ "bindings": {`
	`81`	`+ "kafka": {}`
`82`	`82`	`}`
`83`	`83`	`},`
`84`		`- "example-producer-topic": {`
`85`		`- "subscribe": {`
	`84`	`+ "multi-payload-topic": {`
	`85`	`+ "publish": {`
`86`	`86`	`"bindings": {`
`87`	`87`	`"kafka": {}`
`88`	`88`	`},`
`@@ -104,6 +104,9 @@`
`104`	`104`	`}`
`105`	`105`	`]`
`106`	`106`	`}`
	`107`	`+ },`
	`108`	`+ "bindings": {`
	`109`	`+ "kafka": {}`
`107`	`110`	`}`
`108`	`111`	`}`
`109`	`112`	`},`
`@@ -156,4 +159,4 @@`
`156`	`159`	`}`
`157`	`160`	`}`
`158`	`161`	`}`
`159`		`-}`
	`162`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ plugins {`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`group 'io.github.springwolf'`
`12`		`-version '0.2.0'`
	`12`	`+version '0.3.0'`
`13`	`13`	`sourceCompatibility = 1.8`
`14`	`14`
`15`	`15`	`repositories {`