Axual .NET Client Documentation

Welcome to the Axual .NET Client documentation, Use the menu on the left to navigate through the various sections.

Introduction

Axual.Kafka.Proxy is Axual’s .NET client for Apache Kafka, it is based on the open source Confluent .NET Client.

All code snippets included in the documentation can be found in the Axual .NET Client examples repository in form of full runnable applications.

Prerequisites

A computer equipped with:

NET Core 3.1
Your favorite IDE

Setting up NuGet and credentials

Please make sure to include the following packageSources tag in your NuGet.Config, and make sure you have configured the right credentials for that repository as indicated below.

<configuration>
    <packageSources>
        <add key="axual" value="https://dev.axual.io/nexus/repository/axual-nuget/"/>
    </packageSources>
    <packageSourceCredentials>
        <axual>
            <add key="Username" value="[USERNAME]"/>
            <add key="ClearTextPassword" value="[PASSWORD]"/>
        </axual>
    </packageSourceCredentials>
</configuration>

Setting up Dependencies

Start by including the dependency on the Axual .NET client library as you would do with any dependency or by adding PackageReference tag in your .csproj project.

<ItemGroup>
      <PackageReference Include="Axual.Kafka.Proxy" Version="1.0.1" />
      <PackageReference Include="Axual.SchemaRegistry.Serdes.Avro" Version="1.0.1" />
</ItemGroup>

You are all set to create your first producer and consumer.