From f535b94e83a662510e1aef32a85029a1a1612ddb Mon Sep 17 00:00:00 2001 From: Joel Oliveira Date: Wed, 22 Nov 2023 16:59:40 +0000 Subject: [PATCH] docs: update documentation with changes from v3 --- .../create-your-first-application.md | 8 +-- website/docs/getting-started/installation.md | 2 +- website/docs/getting-started/packages.md | 55 +++++++++---------- .../docs/guides/consumers/add-consumers.md | 2 - .../middlewares/batch-consume-middleware.md | 14 ++--- .../middlewares/compressor-middleware.md | 6 +- .../consumer-throttling-middleware.md | 2 +- .../middlewares/serializer-middleware.md | 18 ++---- .../middlewares/typed-handler-middleware.md | 2 +- 9 files changed, 42 insertions(+), 67 deletions(-) diff --git a/website/docs/getting-started/create-your-first-application.md b/website/docs/getting-started/create-your-first-application.md index e8b1e295c..b1a0e671a 100644 --- a/website/docs/getting-started/create-your-first-application.md +++ b/website/docs/getting-started/create-your-first-application.md @@ -58,8 +58,6 @@ Inside the _Producer_ project directory, run the following commands to install t dotnet add package KafkaFlow dotnet add package KafkaFlow.Microsoft.DependencyInjection dotnet add package KafkaFlow.LogHandler.Console -dotnet add package KafkaFlow.TypedHandler -dotnet add package KafkaFlow.Serializer dotnet add package KafkaFlow.Serializer.JsonCore dotnet add package Microsoft.Extensions.DependencyInjection ``` @@ -153,8 +151,6 @@ Inside the _Consumer_ project directory, run the following commands to install t dotnet add package KafkaFlow dotnet add package KafkaFlow.Microsoft.DependencyInjection dotnet add package KafkaFlow.LogHandler.Console -dotnet add package KafkaFlow.TypedHandler -dotnet add package KafkaFlow.Serializer dotnet add package KafkaFlow.Serializer.JsonCore dotnet add package Microsoft.Extensions.DependencyInjection ``` @@ -165,7 +161,6 @@ Create a new class file named _HelloMessageHandler.cs_ and add the following exa ```csharp using KafkaFlow; -using KafkaFlow.TypedHandler; using Producer; namespace Consumer; @@ -193,7 +188,6 @@ Replace the content of the _Program.cs_ with the following example. using KafkaFlow; using KafkaFlow.Serializer; using Microsoft.Extensions.DependencyInjection; -using KafkaFlow.TypedHandler; using Consumer; const string topicName = "sample-topic"; @@ -210,7 +204,7 @@ services.AddKafka(kafka => kafka .WithBufferSize(100) .WithWorkersCount(10) .AddMiddlewares(middlewares => middlewares - .AddSerializer() + .AddDeserializer() .AddTypedHandlers(h => h.AddHandler()) ) ) diff --git a/website/docs/getting-started/installation.md b/website/docs/getting-started/installation.md index 000abed77..08b40a7f7 100644 --- a/website/docs/getting-started/installation.md +++ b/website/docs/getting-started/installation.md @@ -59,7 +59,7 @@ public void ConfigureServices(IServiceCollection services) .WithBufferSize(100) .WithWorkersCount(10) .AddMiddlewares(middlewares => middlewares - .AddSerializer() + .AddDeserializer() .AddTypedHandlers(handlers => handlers .AddHandler()) ) diff --git a/website/docs/getting-started/packages.md b/website/docs/getting-started/packages.md index 198e8595e..74ef92e4b 100644 --- a/website/docs/getting-started/packages.md +++ b/website/docs/getting-started/packages.md @@ -6,39 +6,34 @@ sidebar_position: 4 ## Core -| Package | NuGet Stable | Downloads | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [KafkaFlow](https://www.nuget.org/packages/KafkaFlow/) | [![KafkaFlow](https://img.shields.io/nuget/v/KafkaFlow.svg)](https://www.nuget.org/packages/KafkaFlow/) | [![KafkaFlow](https://img.shields.io/nuget/dt/KafkaFlow.svg)](https://www.nuget.org/packages/KafkaFlow/) | -| [KafkaFlow.Abstractions](https://www.nuget.org/packages/KafkaFlow.Abstractions/) | [![KafkaFlow.Abstractions](https://img.shields.io/nuget/v/KafkaFlow.Abstractions.svg)](https://www.nuget.org/packages/KafkaFlow.Abstractions/) | [![KafkaFlow](https://img.shields.io/nuget/dt/KafkaFlow.Abstractions.svg)](https://www.nuget.org/packages/KafkaFlow.Abstractions/) | -| [KafkaFlow.Extensions.Hosting](https://www.nuget.org/packages/KafkaFlow.Extensions.Hosting/) | [![KafkaFlow.Extensions.Hosting](https://img.shields.io/nuget/v/KafkaFlow.Extensions.Hosting.svg)](https://www.nuget.org/packages/KafkaFlow.Extensions.Hosting/) | [![KafkaFlow](https://img.shields.io/nuget/dt/KafkaFlow.Extensions.Hosting.svg)](https://www.nuget.org/packages/KafkaFlow.Extensions.Hosting/) | -| [KafkaFlow.LogHandler.Console](https://www.nuget.org/packages/KafkaFlow.LogHandler.Console/) | [![KafkaFlow.LogHandler.Console](https://img.shields.io/nuget/v/KafkaFlow.LogHandler.Console.svg)](https://www.nuget.org/packages/KafkaFlow.LogHandler.Console/) | [![KafkaFlow.LogHandler.Console](https://img.shields.io/nuget/dt/KafkaFlow.LogHandler.Console.svg)](https://www.nuget.org/packages/KafkaFlow.LogHandler.Console/) | +| Package | NuGet Stable | Downloads | +| -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [KafkaFlow](https://www.nuget.org/packages/KafkaFlow/) | [![KafkaFlow](https://img.shields.io/nuget/v/KafkaFlow.svg)](https://www.nuget.org/packages/KafkaFlow/) | [![KafkaFlow](https://img.shields.io/nuget/dt/KafkaFlow.svg)](https://www.nuget.org/packages/KafkaFlow/) | +| [KafkaFlow.Abstractions](https://www.nuget.org/packages/KafkaFlow.Abstractions/) | [![KafkaFlow.Abstractions](https://img.shields.io/nuget/v/KafkaFlow.Abstractions.svg)](https://www.nuget.org/packages/KafkaFlow.Abstractions/) | [![KafkaFlow](https://img.shields.io/nuget/dt/KafkaFlow.Abstractions.svg)](https://www.nuget.org/packages/KafkaFlow.Abstractions/) | +| [KafkaFlow.Extensions.Hosting](https://www.nuget.org/packages/KafkaFlow.Extensions.Hosting/) | [![KafkaFlow.Extensions.Hosting](https://img.shields.io/nuget/v/KafkaFlow.Extensions.Hosting.svg)](https://www.nuget.org/packages/KafkaFlow.Extensions.Hosting/) | [![KafkaFlow](https://img.shields.io/nuget/dt/KafkaFlow.Extensions.Hosting.svg)](https://www.nuget.org/packages/KafkaFlow.Extensions.Hosting/) | +| [KafkaFlow.LogHandler.Console](https://www.nuget.org/packages/KafkaFlow.LogHandler.Console/) | [![KafkaFlow.LogHandler.Console](https://img.shields.io/nuget/v/KafkaFlow.LogHandler.Console.svg)](https://www.nuget.org/packages/KafkaFlow.LogHandler.Console/) | [![KafkaFlow.LogHandler.Console](https://img.shields.io/nuget/dt/KafkaFlow.LogHandler.Console.svg)](https://www.nuget.org/packages/KafkaFlow.LogHandler.Console/) | ## Serialization -| Package | NuGet Stable | Downloads | -| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [KafkaFlow.Serializer](https://www.nuget.org/packages/KafkaFlow.Serializer/) | [![KafkaFlow.Serializer](https://img.shields.io/nuget/v/KafkaFlow.Serializer.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer/) | [![KafkaFlow.Serializer](https://img.shields.io/nuget/dt/KafkaFlow.Serializer.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer/) | -| [KafkaFlow.SchemaRegistry](https://www.nuget.org/packages/KafkaFlow.SchemaRegistry/) | [![KafkaFlow.SchemaRegistry](https://img.shields.io/nuget/v/KafkaFlow.SchemaRegistry.svg)](https://www.nuget.org/packages/KafkaFlow.SchemaRegistry/) | [![KafkaFlow.SchemaRegistry](https://img.shields.io/nuget/dt/KafkaFlow.SchemaRegistry.svg)](https://www.nuget.org/packages/KafkaFlow.SchemaRegistry/) | -| [KafkaFlow.Serializer.ProtobufNet](https://www.nuget.org/packages/KafkaFlow.Serializer.ProtobufNet/) | [![KafkaFlow.Serializer.ProtobufNet](https://img.shields.io/nuget/v/KafkaFlow.Serializer.ProtobufNet.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.ProtobufNet/) | [![KafkaFlow.Serializer.ProtobufNet](https://img.shields.io/nuget/dt/KafkaFlow.Serializer.ProtobufNet.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.ProtobufNet/) | -| [KafkaFlow.Serializer.JsonCore](https://www.nuget.org/packages/KafkaFlow.Serializer.JsonCore/) | [![KafkaFlow.Serializer.JsonCore](https://img.shields.io/nuget/v/KafkaFlow.Serializer.JsonCore.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.JsonCore/) | [![KafkaFlow.Serializer.JsonCore](https://img.shields.io/nuget/dt/KafkaFlow.Serializer.JsonCore.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.JsonCore/) | -| [KafkaFlow.Serializer.NewtonsoftJson](https://www.nuget.org/packages/KafkaFlow.Serializer.NewtonsoftJson/) | [![KafkaFlow.Serializer.NewtonsoftJson](https://img.shields.io/nuget/v/KafkaFlow.Serializer.NewtonsoftJson.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.NewtonsoftJson/) | [![KafkaFlow.Serializer.NewtonsoftJson](https://img.shields.io/nuget/dt/KafkaFlow.Serializer.NewtonsoftJson.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.NewtonsoftJson/) | -| [KafkaFlow.Serializer.SchemaRegistry.ConfluentJson](https://www.nuget.org/packages/KafkaFlow.Serializer.SchemaRegistry.ConfluentJson/) | [![KafkaFlow.Serializer.SchemaRegistry.ConfluentJson](https://img.shields.io/nuget/v/KafkaFlow.Serializer.SchemaRegistry.ConfluentJson.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.SchemaRegistry.ConfluentJson/) | [![KafkaFlow.Serializer.SchemaRegistry.ConfluentJson](https://img.shields.io/nuget/dt/KafkaFlow.Serializer.SchemaRegistry.ConfluentJson.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.SchemaRegistry.ConfluentJson/) | -| [KafkaFlow.Serializer.SchemaRegistry.ConfluentAvro](https://www.nuget.org/packages/KafkaFlow.Serializer.SchemaRegistry.ConfluentAvro/) | [![KafkaFlow.Serializer.SchemaRegistry.ConfluentAvro](https://img.shields.io/nuget/v/KafkaFlow.Serializer.SchemaRegistry.ConfluentAvro.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.SchemaRegistry.ConfluentAvro/) | [![KafkaFlow.Serializer.SchemaRegistry.ConfluentAvro](https://img.shields.io/nuget/dt/KafkaFlow.Serializer.SchemaRegistry.ConfluentAvro.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.SchemaRegistry.ConfluentAvro/) | -| [KafkaFlow.Serializer.SchemaRegistry.ConfluentProtobuf](https://www.nuget.org/packages/KafkaFlow.Serializer.SchemaRegistry.ConfluentProtobuf/) | [![KafkaFlow.Serializer.SchemaRegistry.ConfluentProtobuf](https://img.shields.io/nuget/v/KafkaFlow.Serializer.SchemaRegistry.ConfluentProtobuf.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.SchemaRegistry.ConfluentProtobuf/) | [![KafkaFlow.Serializer.SchemaRegistry.ConfluentProtobuf](https://img.shields.io/nuget/dt/KafkaFlow.Serializer.SchemaRegistry.ConfluentProtobuf.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.SchemaRegistry.ConfluentProtobuf/) | +| Package | NuGet Stable | Downloads | +| ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [KafkaFlow.SchemaRegistry](https://www.nuget.org/packages/KafkaFlow.SchemaRegistry/) | [![KafkaFlow.SchemaRegistry](https://img.shields.io/nuget/v/KafkaFlow.SchemaRegistry.svg)](https://www.nuget.org/packages/KafkaFlow.SchemaRegistry/) | [![KafkaFlow.SchemaRegistry](https://img.shields.io/nuget/dt/KafkaFlow.SchemaRegistry.svg)](https://www.nuget.org/packages/KafkaFlow.SchemaRegistry/) | +| [KafkaFlow.Serializer.ProtobufNet](https://www.nuget.org/packages/KafkaFlow.Serializer.ProtobufNet/) | [![KafkaFlow.Serializer.ProtobufNet](https://img.shields.io/nuget/v/KafkaFlow.Serializer.ProtobufNet.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.ProtobufNet/) | [![KafkaFlow.Serializer.ProtobufNet](https://img.shields.io/nuget/dt/KafkaFlow.Serializer.ProtobufNet.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.ProtobufNet/) | +| [KafkaFlow.Serializer.JsonCore](https://www.nuget.org/packages/KafkaFlow.Serializer.JsonCore/) | [![KafkaFlow.Serializer.JsonCore](https://img.shields.io/nuget/v/KafkaFlow.Serializer.JsonCore.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.JsonCore/) | [![KafkaFlow.Serializer.JsonCore](https://img.shields.io/nuget/dt/KafkaFlow.Serializer.JsonCore.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.JsonCore/) | +| [KafkaFlow.Serializer.NewtonsoftJson](https://www.nuget.org/packages/KafkaFlow.Serializer.NewtonsoftJson/) | [![KafkaFlow.Serializer.NewtonsoftJson](https://img.shields.io/nuget/v/KafkaFlow.Serializer.NewtonsoftJson.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.NewtonsoftJson/) | [![KafkaFlow.Serializer.NewtonsoftJson](https://img.shields.io/nuget/dt/KafkaFlow.Serializer.NewtonsoftJson.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.NewtonsoftJson/) | +| [KafkaFlow.Serializer.SchemaRegistry.ConfluentJson](https://www.nuget.org/packages/KafkaFlow.Serializer.SchemaRegistry.ConfluentJson/) | [![KafkaFlow.Serializer.SchemaRegistry.ConfluentJson](https://img.shields.io/nuget/v/KafkaFlow.Serializer.SchemaRegistry.ConfluentJson.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.SchemaRegistry.ConfluentJson/) | [![KafkaFlow.Serializer.SchemaRegistry.ConfluentJson](https://img.shields.io/nuget/dt/KafkaFlow.Serializer.SchemaRegistry.ConfluentJson.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.SchemaRegistry.ConfluentJson/) | +| [KafkaFlow.Serializer.SchemaRegistry.ConfluentAvro](https://www.nuget.org/packages/KafkaFlow.Serializer.SchemaRegistry.ConfluentAvro/) | [![KafkaFlow.Serializer.SchemaRegistry.ConfluentAvro](https://img.shields.io/nuget/v/KafkaFlow.Serializer.SchemaRegistry.ConfluentAvro.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.SchemaRegistry.ConfluentAvro/) | [![KafkaFlow.Serializer.SchemaRegistry.ConfluentAvro](https://img.shields.io/nuget/dt/KafkaFlow.Serializer.SchemaRegistry.ConfluentAvro.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.SchemaRegistry.ConfluentAvro/) | +| [KafkaFlow.Serializer.SchemaRegistry.ConfluentProtobuf](https://www.nuget.org/packages/KafkaFlow.Serializer.SchemaRegistry.ConfluentProtobuf/) | [![KafkaFlow.Serializer.SchemaRegistry.ConfluentProtobuf](https://img.shields.io/nuget/v/KafkaFlow.Serializer.SchemaRegistry.ConfluentProtobuf.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.SchemaRegistry.ConfluentProtobuf/) | [![KafkaFlow.Serializer.SchemaRegistry.ConfluentProtobuf](https://img.shields.io/nuget/dt/KafkaFlow.Serializer.SchemaRegistry.ConfluentProtobuf.svg)](https://www.nuget.org/packages/KafkaFlow.Serializer.SchemaRegistry.ConfluentProtobuf/) | ## Compression -| Package | NuGet Stable | Downloads | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [KafkaFlow.Compressor](https://www.nuget.org/packages/KafkaFlow.Compressor/) | [![KafkaFlow.Compressor](https://img.shields.io/nuget/v/KafkaFlow.Compressor.svg)](https://www.nuget.org/packages/KafkaFlow.Compressor/) | [![KafkaFlow.Compressor](https://img.shields.io/nuget/dt/KafkaFlow.Compressor.svg)](https://www.nuget.org/packages/KafkaFlow.Compressor/) | -| [KafkaFlow.Compressor.Gzip](https://www.nuget.org/packages/KafkaFlow.Compressor.Gzip/) | [![KafkaFlow.Compressor.Gzip](https://img.shields.io/nuget/v/KafkaFlow.Compressor.Gzip.svg)](https://www.nuget.org/packages/KafkaFlow.Compressor.Gzip/) | [![KafkaFlow.Compressor.Gzip](https://img.shields.io/nuget/dt/KafkaFlow.Compressor.Gzip.svg)](https://www.nuget.org/packages/KafkaFlow.Compressor.Gzip/) | +| Package | NuGet Stable | Downloads | +| -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [KafkaFlow.Compressor.Gzip](https://www.nuget.org/packages/KafkaFlow.Compressor.Gzip/) | [![KafkaFlow.Compressor.Gzip](https://img.shields.io/nuget/v/KafkaFlow.Compressor.Gzip.svg)](https://www.nuget.org/packages/KafkaFlow.Compressor.Gzip/) | [![KafkaFlow.Compressor.Gzip](https://img.shields.io/nuget/dt/KafkaFlow.Compressor.Gzip.svg)](https://www.nuget.org/packages/KafkaFlow.Compressor.Gzip/) | + + -## Middlewares -| Package | NuGet Stable | Downloads | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [KafkaFlow.TypedHandler](https://www.nuget.org/packages/KafkaFlow.TypedHandler/) | [![KafkaFlow.TypedHandler](https://img.shields.io/nuget/v/KafkaFlow.TypedHandler.svg)](https://www.nuget.org/packages/KafkaFlow.TypedHandler/) | [![KafkaFlow.TypedHandler](https://img.shields.io/nuget/dt/KafkaFlow.TypedHandler.svg)](https://www.nuget.org/packages/KafkaFlow.TypedHandler/) | -| [KafkaFlow.BatchConsume](https://www.nuget.org/packages/KafkaFlow.BatchConsume/) | [![KafkaFlow.BatchConsume](https://img.shields.io/nuget/v/KafkaFlow.BatchConsume.svg)](https://www.nuget.org/packages/KafkaFlow.BatchConsume/) | [![KafkaFlow.BatchConsume](https://img.shields.io/nuget/dt/KafkaFlow.BatchConsume.svg)](https://www.nuget.org/packages/KafkaFlow.BatchConsume/) | ## Dependency Injection @@ -49,8 +44,8 @@ sidebar_position: 4 ## Administration -| Package | NuGet Stable | Downloads | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [KafkaFlow.Admin](https://www.nuget.org/packages/KafkaFlow.Admin/) | [![KafkaFlow.Admin](https://img.shields.io/nuget/v/KafkaFlow.Admin.svg)](https://www.nuget.org/packages/KafkaFlow.Admin/) | [![KafkaFlow.Admin](https://img.shields.io/nuget/dt/KafkaFlow.Admin.svg)](https://www.nuget.org/packages/KafkaFlow.Admin/) | -| [KafkaFlow.Admin.WebApi](https://www.nuget.org/packages/KafkaFlow.Admin.WebApi/) | [![KafkaFlow.Admin.WebApi](https://img.shields.io/nuget/v/KafkaFlow.Admin.WebApi.svg)](https://www.nuget.org/packages/KafkaFlow.Admin.WebApi/) | [![KafkaFlow.Admin.WebApi](https://img.shields.io/nuget/dt/KafkaFlow.Admin.WebApi.svg)](https://www.nuget.org/packages/KafkaFlow.Admin.WebApi/) | -| [KafkaFlow.Admin.Dashboard](https://www.nuget.org/packages/KafkaFlow.Admin.Dashboard/) | [![KafkaFlow.Admin.Dashboard](https://img.shields.io/nuget/v/KafkaFlow.Admin.Dashboard.svg)](https://www.nuget.org/packages/KafkaFlow.Admin.Dashboard/) | [![KafkaFlow.Admin.Dashboard](https://img.shields.io/nuget/dt/KafkaFlow.Admin.Dashboard.svg)](https://www.nuget.org/packages/KafkaFlow.Admin.Dashboard/) | \ No newline at end of file +| Package | NuGet Stable | Downloads | +| -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [KafkaFlow.Admin](https://www.nuget.org/packages/KafkaFlow.Admin/) | [![KafkaFlow.Admin](https://img.shields.io/nuget/v/KafkaFlow.Admin.svg)](https://www.nuget.org/packages/KafkaFlow.Admin/) | [![KafkaFlow.Admin](https://img.shields.io/nuget/dt/KafkaFlow.Admin.svg)](https://www.nuget.org/packages/KafkaFlow.Admin/) | +| [KafkaFlow.Admin.WebApi](https://www.nuget.org/packages/KafkaFlow.Admin.WebApi/) | [![KafkaFlow.Admin.WebApi](https://img.shields.io/nuget/v/KafkaFlow.Admin.WebApi.svg)](https://www.nuget.org/packages/KafkaFlow.Admin.WebApi/) | [![KafkaFlow.Admin.WebApi](https://img.shields.io/nuget/dt/KafkaFlow.Admin.WebApi.svg)](https://www.nuget.org/packages/KafkaFlow.Admin.WebApi/) | +| [KafkaFlow.Admin.Dashboard](https://www.nuget.org/packages/KafkaFlow.Admin.Dashboard/) | [![KafkaFlow.Admin.Dashboard](https://img.shields.io/nuget/v/KafkaFlow.Admin.Dashboard.svg)](https://www.nuget.org/packages/KafkaFlow.Admin.Dashboard/) | [![KafkaFlow.Admin.Dashboard](https://img.shields.io/nuget/dt/KafkaFlow.Admin.Dashboard.svg)](https://www.nuget.org/packages/KafkaFlow.Admin.Dashboard/) | \ No newline at end of file diff --git a/website/docs/guides/consumers/add-consumers.md b/website/docs/guides/consumers/add-consumers.md index 0d2ae78bd..02b8c064e 100644 --- a/website/docs/guides/consumers/add-consumers.md +++ b/website/docs/guides/consumers/add-consumers.md @@ -40,7 +40,6 @@ Using the `Topic()` or `Topics()` methods, the consumer will trigger the automat using KafkaFlow; using KafkaFlow.Serializer; using Microsoft.Extensions.DependencyInjection; -using KafkaFlow.TypedHandler; services.AddKafka(kafka => kafka .AddCluster(cluster => cluster @@ -63,7 +62,6 @@ The client application can specify the topic partitions manually using the `Manu using KafkaFlow; using KafkaFlow.Serializer; using Microsoft.Extensions.DependencyInjection; -using KafkaFlow.TypedHandler; services.AddKafka(kafka => kafka .AddCluster(cluster => cluster diff --git a/website/docs/guides/middlewares/batch-consume-middleware.md b/website/docs/guides/middlewares/batch-consume-middleware.md index 6fcbeb2d7..248294597 100644 --- a/website/docs/guides/middlewares/batch-consume-middleware.md +++ b/website/docs/guides/middlewares/batch-consume-middleware.md @@ -10,15 +10,9 @@ The Batch Consume Middleware is used to accumulate a number of messages or wait ## How to use it -Install the [KafkaFlow.BatchConsume](https://www.nuget.org/packages/KafkaFlow.BatchConsume) package. +On the configuration, use the `AddBatching` extension method to add the middleware to your consumer middlewares. -```bash -dotnet add package KafkaFlow.BatchConsume -``` - -On the configuration, use the `BatchConsume` extension method to add the middleware to your consumer middlewares. - -The `BatchConsume` method has two arguments: +The `AddBatching` method has two arguments: - The first one must define the maximum batch size. - The second one defines the `TimeSpan` that the Middleware waits for new messages to be part of the batch. @@ -33,7 +27,7 @@ services.AddKafka(kafka => kafka .AddMiddlewares( middlewares => middlewares ... - .BatchConsume(100, TimeSpan.FromSeconds(10)) // Configuration of the BatchConsumeMiddleware + .AddBatching(100, TimeSpan.FromSeconds(10)) // Configuration of the BatchConsumeMiddleware .Add() // Middleware to process the batch ) ) @@ -48,7 +42,7 @@ When using the `Batch Consume` middleware, the `IServiceScopeFactory` should be ::: ```csharp -using KafkaFlow.BatchConsume; +using KafkaFlow; internal class HandlingMiddleware : IMessageMiddleware { diff --git a/website/docs/guides/middlewares/compressor-middleware.md b/website/docs/guides/middlewares/compressor-middleware.md index 819b70127..8490e8617 100644 --- a/website/docs/guides/middlewares/compressor-middleware.md +++ b/website/docs/guides/middlewares/compressor-middleware.md @@ -14,13 +14,13 @@ If you want to build your own way of compress and decompress messages, you can f ## Add a Compressor Middleware -Install the [KafkaFlow.Compressor](https://www.nuget.org/packages/KafkaFlow.Compressor/) package and add the `AddCompressor` extension method to your producer/consumer middlewares to use it. +Add the `AddCompressor`/`AddDecompressor` extension method to your producer/consumer middlewares to use it. -The method receives a class that implements the `IMessageCompressor` interface as a generic argument. This class will be used in the compress/decompress process. +The method receives a class that implements the `ICompressor`/`IDecompressor` interface as a generic argument. This class will be used in the compress/decompress process. A class instance can be provided as an argument through a factory method too. -Install the [KafkaFlow.Compressor.Gzip](https://www.nuget.org/packages/KafkaFlow.Compressor.Gzip/) package to use the `GzipMessageCompressor` that uses the GZIP algorithm. +Install the [KafkaFlow.Compressor.Gzip](https://www.nuget.org/packages/KafkaFlow.Compressor.Gzip/) package to use the `GzipMessageCompressor`/`GzipMessageDecompressor` that uses the GZIP algorithm. ```csharp public class Startup diff --git a/website/docs/guides/middlewares/consumer-throttling-middleware.md b/website/docs/guides/middlewares/consumer-throttling-middleware.md index 2c4014b62..63a65892e 100644 --- a/website/docs/guides/middlewares/consumer-throttling-middleware.md +++ b/website/docs/guides/middlewares/consumer-throttling-middleware.md @@ -30,7 +30,7 @@ Configuring Consumer Throttling is straightforward with the fluent interface pro .AddAction(a => a.AboveThreshold(10).ApplyDelay(100)) .AddAction(a => a.AboveThreshold(100).ApplyDelay(1_000)) .AddAction(a => a.AboveThreshold(1_000).ApplyDelay(10_000))) - .AddSerializer() + .AddDeserializer() ) ) ``` diff --git a/website/docs/guides/middlewares/serializer-middleware.md b/website/docs/guides/middlewares/serializer-middleware.md index 674d92294..829b51311 100644 --- a/website/docs/guides/middlewares/serializer-middleware.md +++ b/website/docs/guides/middlewares/serializer-middleware.md @@ -15,21 +15,15 @@ You can use one of the following common serializers or build your own: ## How to use it -Install the [KafkaFlow.Serializer](https://www.nuget.org/packages/KafkaFlow.Serializer) package. +On the configuration, add the `AddSerializer`/`AddDeserializer` extension method to your producer/consumer middlewares to use it. -```bash -dotnet add package KafkaFlow.Serializer -``` - -On the configuration, add the `AddSerializer` extension method to your producer/consumer middlewares to use it. - -The `AddSerializer` method has two arguments: - - The first one must implement the `IMessageSerializer` interface. +The `AddSerializer`/`AddDeserializer` method has two arguments: + - The first one must implement the `ISerializer`/`IDeserializer` interface. - The second one is optional and must implement the `IMessageTypeResolver` interface. If the parameter is not provided, then the `DefaultTypeResolver` will be used. Both classes can be provided as an argument through a factory method too. :::tip -For topics that have just one message type, use the `AddSingleTypeSerializer` method. +For topics that have just one message type, use the `AddSingleTypeSerializer`/`AddSingleTypeDeserializer` method. :::tip @@ -87,7 +81,7 @@ public class Startup ) .AddConsumer( ... - .AddMiddlewares(middlewares => middlewares.AddSchemaRegistryAvroSerializer() + .AddMiddlewares(middlewares => middlewares.AddSchemaRegistryAvroDeserializer() ) ) ); @@ -108,7 +102,7 @@ You can see a detailed explanation [here](https://docs.confluent.io/platform/cur A type resolver is needed to instruct the middleware where to find the destination message type in the message metadata when consuming and where to store it when producing. -The framework has the `DefaultTypeResolver` that will be used omitting the second type parameter in the `AddSerializer` method. You can create your own implementation of `IMessageTypeResolver` to allow communication with other frameworks. +The framework has the `DefaultTypeResolver` that will be used omitting the second type parameter in the `AddSerializer`/`AddDeserializer` method. You can create your own implementation of `IMessageTypeResolver` to allow communication with other frameworks. ```csharp public class SampleMessageTypeResolver : IMessageTypeResolver diff --git a/website/docs/guides/middlewares/typed-handler-middleware.md b/website/docs/guides/middlewares/typed-handler-middleware.md index e0144299e..63b827d91 100644 --- a/website/docs/guides/middlewares/typed-handler-middleware.md +++ b/website/docs/guides/middlewares/typed-handler-middleware.md @@ -24,7 +24,7 @@ When using a Schema Registry, the schema is read from it, and the first 5 bytes #### Without Schema Registry Using other serializers with no Schema Registry, the `DefaultTypeResolver` is used by default. The `DefaultTypeResolver` uses the header `Message-Type` to identify the message type based on the Type fully qualified name. -It's also possible to write your own `TypeResolver` implementing the `IMessageTypeResolver` interface and using it in the `AddSerializer` method in the consumer/producer middleware. +It's also possible to write your own `TypeResolver` implementing the `IMessageTypeResolver` interface and using it in the `AddSerializer`/`AddDeserializer` method in the consumer/producer middleware. ## Configure Typed Handler