Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/squidmin/kafka-api-blueprint
Reference / template for a Kafka producer-consumer mechanism
https://github.com/squidmin/kafka-api-blueprint
gradle java kafka kafka-api kafka-connect producer-consumer spring spring-boot
Last synced: 9 days ago
JSON representation
Reference / template for a Kafka producer-consumer mechanism
- Host: GitHub
- URL: https://github.com/squidmin/kafka-api-blueprint
- Owner: squidmin
- Created: 2024-06-17T17:00:15.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-06-17T17:22:05.000Z (5 months ago)
- Last Synced: 2024-10-12T22:56:46.756Z (24 days ago)
- Topics: gradle, java, kafka, kafka-api, kafka-connect, producer-consumer, spring, spring-boot
- Language: Java
- Homepage:
- Size: 48.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# kafka-api-blueprint
Reference / template for a Kafka producer-consumer mechanism.
See also:
- [kafka-producer-blueprint](https://github.com/squidmin/kafka-api-blueprint)
- [kafka-consumer-blueprint](https://github.com/squidmin/kafka-consumer-blueprint)
## Build the JAR files
```bash
cd ../kafka-producer-blueprint
./gradlew clean build
```
```bash
cd ../kafka-consumer-blueprint
./gradlew clean build
```
```bash
cd ../kafka-api-blueprint
./gradlew clean build
```
## Start the services
```bash
docker-compose up --build
```
## Verify Kafka Installation
### Create a Kafka topic
```bash
docker-compose exec kafka kafka-topics.sh --create --topic another-test-topic --bootstrap-server kafka:9092 --partitions 1 --replication-factor 1
```
### List Kafka topics
```bash
docker-compose exec kafka kafka-topics.sh --list --bootstrap-server kafka:9092
```
## Test the Kafka integration
- Use Postman or a browser to access the API endpoint:
```
http://localhost:8083/publish?message=HelloKafka
```
- The message will be forwarded to the producer application, which will then publish it to Kafka.
## Stop and remove all containers
```bash
docker-compose down
```
## Remove existing containers, volumes, and images
```bash
docker-compose down -v --rmi all
```
---
## Reference Documentation
* [Official Gradle documentation](https://docs.gradle.org)
* [Spring Boot Gradle Plugin Reference Guide](https://docs.spring.io/spring-boot/docs/3.3.0/gradle-plugin/reference/html/)
* [Spring Configuration Processor](https://docs.spring.io/spring-boot/docs/3.3.0/reference/htmlsingle/index.html#appendix.configuration-metadata.annotation-processor)
* [Spring Boot DevTools](https://docs.spring.io/spring-boot/docs/3.3.0/reference/htmlsingle/index.html#using.devtools)
* [Spring Integration](https://docs.spring.io/spring-boot/docs/3.3.0/reference/htmlsingle/index.html#messaging.spring-integration)
* [Spring for Apache Kafka](https://docs.spring.io/spring-boot/docs/3.3.0/reference/htmlsingle/index.html#messaging.kafka)
## Additional Links
These additional references should also help you:
* [Gradle Build Scans – insights for your project's build](https://scans.gradle.com#gradle)