This repository contains a simple customer REST API that all live under the src.main folder in the repository. There are unit tests for that live in the respective src.test folder.
The REST API is written in Java and the cloned project will need the following to run:
- Java JDK installed
- A Java IDE such as Intellij or Eclipse
- Maven to pull in dependencies
- Name: Customer Mapping Service
- Class Package: com.customermappingservice
- Main API Class Path: com.customermappingservice.Application
- Test Package: com.customermappingservice
To run the unit tests:
- Clone the project locally
- run "mvn clean install" from the terminal on the root folder of the project.
- In the IDE:
- Mark the src/main folder as the sources folder.
- Mark the src/test folder as the test sources folder (So that JUnit will recognize the classes as test classes)
- navigate to the respective test folders for the exercises (Shown below in Structure), and run the unit tests.
-
For the Customer Mapping Service, there are 2 tests under the package:
- AppUtilsTest which tests some of the utility methods such as validating a date etc.
- AppTest which is an end to end api test. NOTE: When one of these tests is ran, the API server will be automatically started and stopped. These tests will need to be ran one at a time.
-
Tests can also be ran through Postman or similar utility by starting the server. It can be started by running com.customermappingservice.Application.main() in an IDE or cmd prompt. the server is start on port 4568 and the base url should be http://localhost:4568/.
-
/getcustomer
- params:
- customerId (Int)
- params:
-
/postcustomer
- params:
- customerId (Int)
- createdAt (String - yyyy-mm-dd)
- params: