generator-jhipster-pulsar

JHipster module to support Apache Pulsar in your JHipster app

Introduction

This is a JHipster module, that is meant to be used in a JHipster application. It provides integration with the Apache Pulsar messaging system.

Prerequisites

As this is a JHipster module, we expect you have JHipster and its related tools already installed (see installing JHipster)

Installation

To install this module:

npm install -g generator-jhipster-pulsar

To update this module:

npm update -g generator-jhipster-pulsar

Usage

At the root of your JHipster app folder, enter:

yo jhipster-pulsar

This will generate:

• a docker-compose file that can be used in development to spawn a dockerized pulsar instance. To launch it:

docker-compose -f src/main/docker/pulsar.yml up -d

• an HTTP endpoint to publish messages:

curl -X POST "http://localhost:8080/api/pulsar/publish/my-topic?message=test"

• a Server-Sent-Event endpoint to consume messages as a stream:

curl "http://localhost:8080/api/pulsar/consume/my-subscription?topic=my-topic"

• integration tests using the Pulsar Testcontainers module

License

Apache-2.0 © Christophe Bornet