Module kafka-proto-serde

The kafka-proto-serde module provides an Apache Kafka Serde/Serializer/Deserializer implementation for Google’s Protocol Buffers (aka. Protobuf, Proto) and some convenience building blocks to ease the Kotlin experience while working with the Java based libraries.

Getting Started

Prerequisites

This library is compatible with the following minimum library versions and everything that was released at the time of writing this document:

• com.google.protobuf:protobuf-java:[2.5,)
• org.apache.kafka:kafka-clients:[0.10,)

Please file an issue if you discovered some incompatibility.

Installing

Gradle

Add the following dependency to your build.gradle.kts script:

dependencies {
    implementation("com.fleshgrinder:kafka-proto-serde:1.0.0")
}

Maven

Add the following dependency to your pom.xml:

<dependency>
    <groupId>com.fleshgrinder</groupId>
    <artifactId>kafka-proto-serde</artifactId>
    <version>1.0.0</version>
</dependency>

Running the Tests

You can execute the usual gradle test command to run the tests with your current JVM installation but to verify that everything works with all dependencies make matrix-test (or bin/matrix-test) is available (requires Bash and Docker). Of course, in case you create a PR, continuous integration, via CircleCI, executes all tests automatically.

Project Info

• Please read CONTRIBUTING.md if you want to contribute, which would be very welcome.
• We use Semantic Versioning and Keep a Changelog, available versions and changes are listed on our releases page.
• This module is licensed under the Unlicense, see UNLICENSE.md for details.