resource-management-api

Resource management api with statemachine

The State Machine

The state machine is a simulation of a resource fulfillment process

The REST-ful API

The REST API exposes links for receiving events to trigger state transitions for the state machine. The server either responds with 202 Accepted if an event was accepted, or 4XX Unprocessable Entity if the event was not accepted by the state machine.

API

• request body

{
  "name":"John Roy",
  "age":32,
  "contractInfo":"EUROPE",
  "state":"ADDED"
  }

• event : [BEGIN-CHECK, APPROVE, UNAPPROVE, ACTIVATE]
• state : [ADDED, IN_CHECK, APPROVED, ACTIVE]

method	api	url	input
POST	Add Employee	http://localhost:8080/api/v1/employees/	request body
PUT	Update Employee	http://localhost:8080/api/v1/employees/	request body
GET	Update Employee	http://localhost:8080/api/v1/employees/{id}	id
PUT	Update Employee State	http://localhost:8080/api/v1/employees/{id}/event	id, event

Current State and Links

{
    "_links": {
        "IN-CHECK": {
            "href": "http://localhost:8080/api/v1/employees/1/BEGIN_CHECK"
        }, 
        "APPROVED": {
            "href": "http://localhost:8080/api/v1/employees/1/APPROVE""
        }, 
        "Move back to IN-CHECK": {
            "href": "http://localhost:8080/api/v1/employees/1/UNAPPROVE""
        }, 
        "ACTIVE": {
            "href": "http://localhost:8080/api/v1/employees/1/ACTIVATE""
        }
    }
}

BUILD & RUN

1. start with clean and fetch all dependencies into local repo

   • mvn clean install

2. Local deployment (ex: IDE or command-line)

   • mvn spring-boot:run

   Or

3. With Docker

   • docker-compose up (create docker images for api and database)
   • docker ps (list available dockers)

Pre requisites

1. Open JDK 11
2. Spring boot with statemachine, data, open-api, web
3. H2 for testing
4. Postgre-Sql
5. Junit
6. lombok
7. Docker