Sample microservices application with Spring Boot, Zuul, Eureka, MongoDB and RabbitMQ

Sample microservices application for managing products and shopping lists using:

• Spring Boot: Framework for creating standalone Java applications.
• Jersey: JAX-RS reference implementation for creating RESTful web services in Java.
• Jackson: JSON parser for Java.
• MapStruct: Framework for mapping objects in Java.
• Netflix Zuul: API gateway.
• Netflix Eureka: Service discovery.
• RabbitMQ: Message broker.
• MongoDB: NoSQL database based on documents.

This application consists of four different services:

• Product service: Provides API for managing products. By default it runs on port 8001.
• Shopping list service: Provides API for managing shopping lists. By default it runs on port 8002.
• Service discovery: Netflix Eureka service that discovers and registers other service instances. By default it runs on port 8761.
• API gateway: Netflix Zuul API gateway that sits on the top of the product and shopping list services, providing a gateway for those services. By default it runs on port 8765.

See the diagram below:

External services

This application depends on external services that must be up and running before attempting to run the application:

MongoDB

Shopping and product services use MongoDB for persistence, but different databases are used for each service.

Before running the application, ensure that you have a MongoDB instance running on localhost port 27017 (default port). The product and shopping-list databases will be created by the application if they don't exist.

RabbitMQ

RabbitMQ is used as message broker for communication between the services. When a product is deleted, a message is produced by the product service. This message contains details about the product that has been deleted. The shopping list service consumes the message and removes the deleted product from the shopping lists.

Before running the application, ensure that a RabbitMQ instance is running on localhost port 5672 (default port).

Building and running this application

To build and run this application, follow these steps:

1. Open a command line window or terminal.
2. Navigate to the root directory of the project, where the pom.xml resides.
3. Compile the project: mvn clean compile.
4. Package the application: mvn package.
5. Change into the target directory of the dist module: cd dist/target.
6. You should see a folder with the following or a similar name: microservices-1.0. Change into this folder: cd microservices-1.0.
7. Start the services as indicated below (the order doesn't matter).

Running the service discovery application

1. Open a command line window or terminal.
2. Start the service-discovery application: java -jar service-discovery-1.0.jar.
3. A Netflix Eureka console will be available at http://localhost:8761.

Running the product service application

1. Open a command line window or terminal.
2. Start the product-service application: java -jar product-service-1.0.jar.
3. This service will start on the port 8001 and it will automatically register itself in the service discovery. Check the Eureka console.

Running the shopping list service application

1. Open a command line window or terminal.
2. Start the shopping-list-service application: java -jar shopping-list-service-1.0.jar.
3. This service will start on the port 8002 and it will automatically register itself in the service discovery. Check the Eureka console.

Running the API gateway application

1. Open a command line window or terminal.
2. Start the api-gateway application: java -jar api-gateway-1.0.jar.

Running extra instances (optional)

If you want to, you can run extra instances of product-service and shopping-list-service applications, just use a different port: java -DPORT=8003 -jar product-service-1.0.jar. New instances will automatically register themselves in the service discovery.

Requests coming from the api-gateway service will be balanced between the instances.

REST API overview

The application provides a REST API for managing tasks. See the curl scripts below with the supported operations:

Get all products

curl -X GET \
  'http://localhost:8765/api/products' \
  -H 'Accept: application/json'

Create a product

curl -X POST \
  'http://localhost:8765/api/products' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Cake"
}'

Get a product by id

curl -X GET \
  'http://localhost:8765/api/products/{product-id}' \
  -H 'Accept: application/json'

Update a product

curl -X POST \
  'http://localhost:8765/api/products/{product-id}' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Chocolate cake"
}'

Delete a product by id

curl -X DELETE \
  'http://localhost:8765/api/products/{product-id}'

Get all shopping lists

curl -X GET \
  'http://localhost:8765/api/shopping-lists' \
  -H 'Accept: application/json'

Create a shopping list

curl -X POST \
  'http://localhost:8765/api/shopping-lists' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "My shopping list",
  "items": [
    {
      "id": "{product-id}"
    },
    {
      "id": "{product-id}"
    },
    ...
  ]
}'

Get a shopping list by id

curl -X GET \
  'http://localhost:8765/api/shopping-lists/{shopping-list-id}' \
  -H 'Accept: application/json'

Update a shopping list

curl -X PUT \
  'http://localhost:8765/api/shopping-lists/{shopping-list-id}' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Birthday party",
  "items": [
    {
      "id": "{product-id}"
    },
    {
      "id": "{product-id}"
    },
    ...
  ]
}'

Delete a shopping list by id

curl -X DELETE \
  'http://localhost:8765/api/shopping-lists/{shopping-list-id}'

Targeting the REST API with Postman

Alternatively to curl, you can use Postman to target the REST API. Check the Postman collection and the environment variables as well.