Skip to content

Commit

Permalink
Improve the API contributing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
riccardo-forina committed Mar 22, 2024
1 parent b8017f6 commit e56c18e
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion api/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,22 +49,31 @@ Please commit generated files along with the PR for review.

1. Creating topic

Use the `kafka-topics.sh` tool to manage topics. kafka-topics.sh is part of the [Apache Kafka distribution](https://kafka.apache.org/downloads) and is found in the bin directory.

```
kafka-topics.sh --create --bootstrap-server localhost:9092 --partitions=3 --replication-factor=1 --topic test --command-config ./hack/binscripts.properties
```

2. Produce messages using kcat

Use [`kcat`](https://github.com/edenhill/kcat) to produce messages.

```
kcat -b localhost:9092 -F ./hack/kcat.properties -P -t test
```


4. Consume messages

Use [`kcat`](https://github.com/edenhill/kcat) to consume messages.

```
kcat -b localhost:9092 -F ./hack/kcat.properties -C -t test
kcat -b localhost:9092 -F ./hack/kcat.properties -C -t test
```

6. Interact with the API to view results

`
curl -s -u admin:admin-secret http://localhost:8080/api/v1/consumer-groups | jq
`
Expand Down

0 comments on commit e56c18e

Please sign in to comment.