README.md

kafrest

A simple REST API developed with Golang to communicate with a Kafka broker, provided as a Docker image. The motivation is to provide a simple way to produce and consume messages from a Kafka broker, without the need to install any other tool. That way, it is possible to use tools like Insomnia or Postman to test your worker and your api at the same time.

Installation

docker pull mauricioromagnollo/kafrest:latest

docker run -d -p 8888:8080 -e KAFKA_BROKERCONNECT=kafka:29092 mauricioromagnollo/kafrest:latest

Or, docker-compose.yml example:

services:
  kafrest:
    image: mauricioromagnollo/kafrest:latest
    ports:
      - "8888:8080"
    environment:
      KAFKA_BROKERCONNECT: kafka:29092

Contributing

Contributions are welcome! Feel free to open an issue if you have a way to improve this project.

See CONTRIBUTING for more information.

Documentation

The documentation is available at mauricioromagnollo.github.io/kafrest.

If you are running the project locally, start the documentation using the command:

make docs

So, the documentation will be available at localhost:8000.

License

Distributed under the MIT License. See LICENSE file for more information. © Mauricio Romagnollo