Skip to content

Markdown docs for 3.5.x #21145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hvishwanath wants to merge 1 commit into
base: 3.5
Choose a base branch
from
Open

Markdown docs for 3.5.x #21145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: AK 3.5.X
description: Documentation for AK 3.5.X
weight:
tags: ['kafka', 'docs']
aliases:
keywords:
type: docs
---

110 changes: 0 additions & 110 deletions docs/api.html
View file
Open in desktop

This file was deleted.

99 changes: 99 additions & 0 deletions docs/apis/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
---
title: API
description:
weight: 2
tags: ['kafka', 'docs']
aliases:
keywords:
type: docs
---

Kafka includes five core apis:

1. The Producer API allows applications to send streams of data to topics in the Kafka cluster.
2. The Consumer API allows applications to read streams of data from topics in the Kafka cluster.
3. The Streams API allows transforming streams of data from input topics to output topics.
4. The Connect API allows implementing connectors that continually pull from some source system or application into Kafka or push from Kafka into some sink system or application.
5. The Admin API allows managing and inspecting topics, brokers, and other Kafka objects.
Kafka exposes all its functionality over a language independent protocol which has clients available in many programming languages. However only the Java clients are maintained as part of the main Kafka project, the others are available as independent open source projects. A list of non-Java clients is available [here](https://cwiki.apache.org/confluence/display/KAFKA/Clients).

# Producer API

The Producer API allows applications to send streams of data to topics in the Kafka cluster.

Examples showing how to use the producer are given in the [javadocs](/35/javadoc/index.html?org/apache/kafka/clients/producer/KafkaProducer.html "Kafka 3.5 Javadoc").

To use the producer, you can use the following maven dependency:


<dependency>
<groupId>org.apache.kafka</groupId>
<artifactId>kafka-clients</artifactId>
<version>3.5.2</version>
</dependency>

# Consumer API

The Consumer API allows applications to read streams of data from topics in the Kafka cluster.

Examples showing how to use the consumer are given in the [javadocs](/35/javadoc/index.html?org/apache/kafka/clients/consumer/KafkaConsumer.html "Kafka 3.5 Javadoc").

To use the consumer, you can use the following maven dependency:


<dependency>
<groupId>org.apache.kafka</groupId>
<artifactId>kafka-clients</artifactId>
<version>3.5.2</version>
</dependency>

# Streams API

The Streams API allows transforming streams of data from input topics to output topics.

Examples showing how to use this library are given in the [javadocs](/35/javadoc/index.html?org/apache/kafka/streams/KafkaStreams.html "Kafka 3.5 Javadoc")

Additional documentation on using the Streams API is available [here](/35/streams).

To use Kafka Streams you can use the following maven dependency:


<dependency>
<groupId>org.apache.kafka</groupId>
<artifactId>kafka-streams</artifactId>
<version>3.5.2</version>
</dependency>

When using Scala you may optionally include the `kafka-streams-scala` library. Additional documentation on using the Kafka Streams DSL for Scala is available [in the developer guide](/35/streams/developer-guide/dsl-api.html#scala-dsl).

To use Kafka Streams DSL for Scala for Scala 2.13 you can use the following maven dependency:


<dependency>
<groupId>org.apache.kafka</groupId>
<artifactId>kafka-streams-scala_2.13</artifactId>
<version>3.5.2</version>
</dependency>

# Connect API

The Connect API allows implementing connectors that continually pull from some source data system into Kafka or push from Kafka into some sink data system.

Many users of Connect won't need to use this API directly, though, they can use pre-built connectors without needing to write any code. Additional information on using Connect is available [here](/documentation.html#connect).

Those who want to implement custom connectors can see the [javadoc](/35/javadoc/index.html?org/apache/kafka/connect "Kafka 3.5 Javadoc").

# Admin API

The Admin API supports managing and inspecting topics, brokers, acls, and other Kafka objects.

To use the Admin API, add the following Maven dependency:


<dependency>
<groupId>org.apache.kafka</groupId>
<artifactId>kafka-clients</artifactId>
<version>3.5.2</version>
</dependency>

For more information about the Admin APIs, see the [javadoc](/35/javadoc/index.html?org/apache/kafka/clients/admin/Admin.html "Kafka 3.5 Javadoc").
Loading