Skip to content

Commit cdd2566

Browse files
docs: enhance Kafka adapter documentation with detailed class and async configuration information
- Expanded the Kafka adapter documentation to include descriptions of five adapter classes for admin, sync, and async operations. - Updated the tutorial to reflect the addition of async variants and their specific configuration options. - Improved logging examples in the tutorial for better clarity and consistency. - Added a section on async adapters, detailing their lazy initialization and usage in non-async contexts.
1 parent e204f9f commit cdd2566

2 files changed

Lines changed: 277 additions & 52 deletions

File tree

docs/api_reference/adapters/kafka.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,22 @@ description: API reference for the Kafka adapter ports, adapters, and mocks.
55

66
# Kafka
77

8-
The `kafka` adapter provides integration with Apache Kafka for producing and consuming messages in event-driven
9-
architectures.
8+
The `kafka` adapter provides integration with Apache Kafka for producing and consuming messages in
9+
event-driven architectures. It ships **five** adapter classes — one for admin operations and two
10+
sync/async pairs for producing and consuming.
11+
12+
| Class | Mode | Port |
13+
|-----------------------------|-------|--------------------------|
14+
| `KafkaAdminAdapter` | sync | `KafkaAdminPort` |
15+
| `KafkaProducerAdapter` | sync | `KafkaProducerPort` |
16+
| `KafkaConsumerAdapter` | sync | `KafkaConsumerPort` |
17+
| `AsyncKafkaProducerAdapter` | async | `AsyncKafkaProducerPort` |
18+
| `AsyncKafkaConsumerAdapter` | async | `AsyncKafkaConsumerPort` |
1019

1120
## Ports
1221

13-
Abstract port interface defining the Kafka adapter contract for message production and consumption.
22+
Abstract port interfaces defining the Kafka adapter contracts for sync and async message
23+
production and consumption.
1424

1525
::: archipy.adapters.kafka.ports
1626
options:
@@ -19,7 +29,8 @@ heading_level: 3
1929

2030
## Adapters
2131

22-
Concrete Kafka adapter implementing producer and consumer patterns with ArchiPy conventions.
32+
Concrete Kafka adapter implementations for both sync and async producer/consumer patterns,
33+
built on `confluent_kafka` and `confluent_kafka.aio`.
2334

2435
::: archipy.adapters.kafka.adapters
2536
options:

0 commit comments

Comments
 (0)