a-coppens / javacodingtest

JavaCodingTest

UML Diagram

Assumptions

Some Assumptions during the API development were made including:

1. No database is needed - a query is sent from another service/microservice and the payslips will be returned to them as JSON
2. Data validation not required - another microservice will already have an existing database and knowledge of the format to query this microservice with.

AWS URL

1. The application is currently hosted on AWS' Fargate through an ECR docker image at http://awscd-myfar-1e3hl0voh2gst-1630703603.ap-southeast-2.elb.amazonaws.com/generate
2. The application requires a body to return anything, this can be done through an API tool such as Postman - https://www.postman.com/
3. Use a get request and hitting the above mentioned endpoint with a body formatted like below in the raw format

4 . The API should send a response body such as the one below

Docker Deployment.

Note: requires docker (hosted at https://hub.docker.com/repository/docker/adamcoppens/coding-test-app)

1. docker pull adamcoppens/coding-test-app
2. docker run -p 8080:8080 adamcoppens/coding-test-app
3. send json bodies as shown in other examples to http://localhost:8080/generate

Local IDE Deployment

1. Run Program from CodingTestApplication.java Start Point (Backend currently runs on localhost:8080)
2. Using an API testing tool such as Postman send JSON objects as a GET request formatted like below through the body to the endpoint: http://localhost:8080/generate

3. Verify Results
   

javacodingtest's Issues

Add: Functionality to send a body to /generate endpoint

allow an employee payslip to be created dynamically

Fix: JSON Output

JSON Output should contain a nested object

e.g nested input data, un-nested output data as shown below

Current Output

Fix: Date input and output

Date input should be a number to represent the date (0-11) or (1-12) and the output range should be mapped to the 1st day of the month to the last day of the month

e.g when input

paymentMonth = 2;

output

paymentStartDate = 01 February;
paymentEndDate = 28 February;