kafka documentation

.vscode/launch.json

@@ -98,6 +98,15 @@
  },
  {
  "type": "java",
+ "name": "Spring Boot-TestBootKafkaSampleApplication<spring-boot-kafka-sample>",
+ "request": "launch",
+ "cwd": "${workspaceFolder}",
+ "mainClass": "com.example.springbootkafkasample.TestBootKafkaSampleApplication",
+ "projectName": "spring-boot-kafka-sample",
+ "args": "",
+ "envFile": "${workspaceFolder}/.env"
+ },
+ {
  "name": "Spring Boot-Application<spring-modulith-outbox-pattern>",
  "request": "launch",
  "cwd": "${workspaceFolder}",

.vscode/settings.json

@@ -1,5 +1,6 @@
 {
  "java.jdt.ls.vmargs": "-XX:+UseParallelGC -XX:GCTimeRatio=4 -XX:AdaptiveSizePolicyWeight=90 -Dsun.zip.disableMemoryMapping=true -Xmx2G -Xms100m -javaagent:\"/workspace/.vscode-remote/extensions/gabrielbb.vscode-lombok-1.0.1/server/lombok.jar\"",
  "java.configuration.updateBuildConfiguration": "automatic",
- "java.compile.nullAnalysis.mode": "automatic"
+ "java.compile.nullAnalysis.mode": "automatic",
+ "java.debug.settings.onBuildFailureProceed": true
 }

kafka-sample/spring-boot/README.md

@@ -3,3 +3,7 @@
 This sample demonstrates sending message to topic (test_1), after listening to it will send the same message to (test_2).
 
 test_2 topic is configured for validation and if it fails then it will be retried for 3 times and moved to deadletter queue using non blocking way
+
+
+### URLS
+* KafkaUI : http://localhost:8080/springwolf/asyncapi-ui.html

kafka-sample/spring-boot/pom.xml

@@ -49,6 +49,18 @@
  <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
  <version>${springdoc-openapi.version}</version>
  </dependency>
+ <!-- Provides the documentation API -->
+ <dependency>
+ <groupId>io.github.springwolf</groupId>
+ <artifactId>springwolf-kafka</artifactId>
+ <version>0.13.0</version>
+ </dependency>
+ <!-- Provides the UI - optional (recommended) -->
+ <dependency>
+ <groupId>io.github.springwolf</groupId>
+ <artifactId>springwolf-ui</artifactId>
+ <version>0.13.0</version>
+ </dependency>
 
  <dependency>
  <groupId>org.springframework.boot</groupId>

kafka-sample/spring-boot/src/main/java/com/example/springbootkafkasample/service/sender/Sender.java

@@ -1,6 +1,11 @@
 package com.example.springbootkafkasample.service.sender;
 
+import static org.springframework.kafka.support.mapping.AbstractJavaTypeMapper.DEFAULT_CLASSID_FIELD_NAME;
+
 import com.example.springbootkafkasample.dto.MessageDTO;
+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 java.util.UUID;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -18,6 +23,21 @@ public Sender(KafkaTemplate<UUID, MessageDTO> template) {
  this.template = template;
  }
 
+ @AsyncPublisher(
+ operation =
+ @AsyncOperation(
+ channelName = "test1",
+ description = "MessageDTO payload",
+ headers =
+ @AsyncOperation.Headers(
+ schemaName = "SpringKafkaDefaultHeaders",
+ values = {
+ @AsyncOperation.Headers.Header(
+ name = DEFAULT_CLASSID_FIELD_NAME,
+ description = "Spring Type Id Header",
+ value = "com.example.springbootkafkasample.dto.MessageDTO"),
+ })))
+ @KafkaAsyncOperationBinding
  public void send(MessageDTO messageDTO) {
  this.template.send(messageDTO.topic(), UUID.randomUUID(), messageDTO).whenComplete((result, ex) -> {
  if (ex == null) {

kafka-sample/spring-boot/src/main/resources/application.properties

@@ -1,3 +1,5 @@
+server.port=8080
+spring.application.name=boot-kafka-sample
 
 spring.kafka.consumer.group-id=foo
 spring.kafka.consumer.auto-offset-reset=latest
@@ -8,4 +10,20 @@ spring.kafka.consumer.properties.spring.json.trusted.packages=com.example.spring
 
 spring.kafka.producer.key-serializer=org.apache.kafka.common.serialization.UUIDSerializer
 spring.kafka.producer.value-serializer=org.springframework.kafka.support.serializer.JsonSerializer
-spring.threads.virtual.enabled=true
+
+spring.threads.virtual.enabled=true
+
+
+##89 springwolf
+springwolf.docket.base-package=com.example.springbootkafkasample
+springwolf.docket.id=urn:com.example:boot-sample-kafka
+springwolf.docket.default-content-type=application/json
+
+springwolf.docket.info.title=${spring.application.name}
+springwolf.docket.info.version=1.0.0
+springwolf.docket.info.license.name=Apache License 2.0
+
+springwolf.docket.servers.kafka.protocol=kafka
+springwolf.docket.servers.kafka.url=${spring.kafka.bootstrap-servers:localhost:9092}
+
+springwolf.plugin.kafka.publishing.enabled=true