https://github.com/mauricioromagnollo/kafrest

A simple REST API developed with Golang to communicate with a Kafka broker, provided as a Docker image.
https://github.com/mauricioromagnollo/kafrest

docker docker-image dockerhub dockerhub-image github-actions github-pages go golang kafka mkdocs mkdocs-material

Last synced: 3 months ago
JSON representation

A simple REST API developed with Golang to communicate with a Kafka broker, provided as a Docker image.

• Host: GitHub
• URL: https://github.com/mauricioromagnollo/kafrest
• Owner: mauricioromagnollo
• License: mit
• Created: 2023-10-02T19:57:26.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-09-13T12:50:15.000Z (4 months ago)
• Last Synced: 2024-10-07T21:10:49.455Z (4 months ago)
• Topics: docker, docker-image, dockerhub, dockerhub-image, github-actions, github-pages, go, golang, kafka, mkdocs, mkdocs-material
• Language: Makefile
• Homepage: https://hub.docker.com/r/mauricioromagnollo/kafrest
• Size: 23.4 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# **kafrest**



[![BADGE_DOCKER_PULLS](https://img.shields.io/docker/pulls/mauricioromagnollo/kafrest.svg)](https://hub.docker.com/r/mauricioromagnollo/kafrest)

![BADGE_DOCKER_IMAGE_SIZE](https://img.shields.io/docker/image-size/mauricioromagnollo/kafrest/latest)

![BADGE_GOLANG](https://img.shields.io/badge/Golang-grey?style=flat&logo=go)

![BADGE_GO_VERSION](https://img.shields.io/github/go-mod/go-version/mauricioromagnollo/kafrest?logo=golang)

![BADGE_LICENSE](https://img.shields.io/github/license/mauricioromagnollo/kafrest)

![BADGE_OPEN_SOURCE](https://badges.frapsoft.com/os/v1/open-source.png?v=103)

![BADGE_ISSUES_OPEN](https://img.shields.io/github/issues/mauricioromagnollo/kafrest?color=green)

![BADGE_ISSUES_CLOSED](https://img.shields.io/github/issues-closed/mauricioromagnollo/kafrest?color=red)



 

> 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**

```sh

docker pull mauricioromagnollo/kafrest:latest

```

```sh

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

```

Or, `docker-compose.yml` example:

```yaml

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](./CONTRIBUTING.md) for more information.

## **Documentation**

The documentation is available at [mauricioromagnollo.github.io/kafrest](https://mauricioromagnollo.github.io/kafrest/).

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

```sh

make docs

```

So, the documentation will be available at [localhost:8000](http://localhost:8000).

## **License**

Distributed under the MIT License. See [LICENSE](./LICENSE) file for more information. © Mauricio Romagnollo