Skip to content

akjava942/employeeserv

Repository files navigation

employeeserv

Application Overview

employeeserv is a spring boot rest application which would provide the CRUD operations for Employee resource.

There are three modules in this application

  • employeeservApi - This module contains the interface.
    • v1/schema/employee.json defines the employee resource.
    • jsonschema2pojo-maven-plugin is being used to create Employee POJO from json file.
    • EmployeeResource.java is the interface for CRUD operations on Employee resource.
      • GET /v1/bfs/employees/{id} endpoint is defined to fetch the resource.
  • employeeservImplementation - This module contains the implementation for the rest endpoints.
    • EmployeeResourceImpl.java implements the EmployeeResource interface.
  • employeeservFunctionalTests - This module would have the functional tests.

How to run the application

  • Please have Maven version 3.3.3 & Java 8 on your system.
  • Use command mvn clean install to build the project.
  • Use command mvn spring-boot:run from employeeservImplementation folder to run the project.
  • Use postman or curl to access http://localhost:8080/v1/bfs/employees/1 GET endpoint. It will return an Employee resource.

Assignment

We would like you to enhance the existing project and see you complete the following requirements:

  • employee.json has only name, and id elements. Please add date of birth and address elements to the Employee resource. Address will have line1, optional line2, city, state, country and zip_code elements.
  • Add one more operation in EmpoyeeResource to create an employee. So EmpoyeeResource will have two operations, one to create, and another to retrieve the employee resource.
  • Implement create, and retrieve operations in EmployeeResourceImpl.java.
  • Resource created using create endpoint should be retrieved using retrieve/get endpoint.
  • Please add the necessary tests to validate your implementation.
  • Please use h2 in-memory database or any other in-memory database to persist the Employee resource. Dependency for h2 in-memory database is already added to the parent pom.
  • Please make sure the validations are done for the requests.
  • Response codes are as per rest guidelines.
  • Error handling in case of failures.
  • Idempotency logic is implemented to avoid duplicate resource creation.

Assignment submission

Thank you very much for your time to take this test. Please upload this complete solution in Github and send us the link to [email protected].

Testing using Swagger

Please run mvn spring-boot:run from employeeservImplementation folder to run the project.

  • Go to brower http://localhost:8080/swagger-ui.html#/

  • Click on the 'EmployeeResourceImpl'

  • Click on 'Try it out' button

  • Copy the request from eiether of the json file that is located at under src/test/java folder.

  • Click on 'Execute' button

  • To Repeat Click on the 'Clear' button and provide the details.

  • Please refer to the results along with the http codes.

Unit Testing:

- Goto src/test/java

- Under the package com.paypal.bfs.employeeserv.functional.test

- Right click on EmployeeResourceTest.java and Run as --> JUnit Test.

- Please verify the results.

About

employee serv - a utility project for technical assesment

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages