Event-Sourced REST API

Simple REST API that uses an event-sourced architecture via the Axon framework.

Prerequisites:

This application talks to redis and Axon servers. To spin up instances of these on your local machine, follow these steps:

• First, install Docker Desktop
  • If you're on Windows, you may then need to manually update WSL to version 2
• Then, pull and run both the official redis Docker image and the official axon Docker image by opening a terminal and running:
  • docker pull redis
  • docker pull axoniq/axonserver:latest-jdk-11-dev-nonroot
• Finally, run the images via the following commands:
  • docker run --name my-redis -p 6379:6379 -d redis
  • docker run -d --name my-axon-server -p 8024:8024 -p 8124:8124 axoniq/axonserver:latest-jdk-11-dev-nonroot

How to run:

Note: Ensure you've completed all of the "prerequisites" listed above first.

To run this application, open the repo in a terminal and execute the following command:

mvn spring-boot:run

How to use:

To try out the REST API, you can copy-paste any of the following cURL request examples into your terminal, or into an application such as Postman.

User CRUD endpoints:

---

Create user:

curl --location --request POST 'localhost:3000/api/user/register' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "myuser",
    "password": "P@ssword123!"
}'

Read user:

curl --location --request GET 'localhost:3000/api/user/80fcdd4a-aa74-45d3-baff-a4281c1aae26'

Update user:

curl --location --request PUT 'localhost:3000/api/user/80fcdd4a-aa74-45d3-baff-a4281c1aae26' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "myuser2",
    "password": "PaaaaaaaSWORD!123"
}'

Delete user:

curl --location --request DELETE 'localhost:3000/api/user/80fcdd4a-aa74-45d3-baff-a4281c1aae26'