Description

It's time to plan the architecture of our service. A good plan is 50% of the result. To begin with, we will determine the functions of our service, group them, and plan the appropriate endpoints following the principles of the REST API:

• Authentication

1. POST api/auth/signup allows the user to register on the service;
2. POST api/auth/changepass changes a user password.

• Business functionality

1. GET api/empl/payment gives access to the employee's payrolls;
2. POST api/acct/payments uploads payrolls;
3. PUT api/acct/payments updates payment information.

• Service functionality

1. PUT api/admin/user/role changes user roles;
2. DELETE api/admin/user deletes a user;
3. GET api/admin/user displays information about all users.

To ensure the security of our service, we will also plan the distribution of roles:

Later, we will reveal the purpose of the roles.

Objectives

In this stage, our goal is to run a SpringBoot web application for our service and test it with one endpoint.

Create and run a SpringBoot application on the 28852 port;

Create the POST api/auth/signup endpoint that accepts data in the JSON format:

{
   "name": "<String value, not empty>",
   "lastname": "<String value, not empty>",
   "email": "<String value, not empty>",
   "password": "<String value, not empty>"
}

It should return a response in the JSON format (without the password field):

{
   "name": "<String value>",
   "lastname": "<String value>",
   "email": "<String value>"
}

If the status is HTTP OK (200), then all fields are correct. If it's HTTP Bad Request (400), then something is wrong. Our service must accept only corporate emails that end with @acme.com. In this stage, we do not check the authentication, so the password field may contain anything (but not empty).

Examples

Example 1: a POST request for api/auth/signup

Request body:

{
   "name": "John",
   "lastname": "Doe",
   "email": "[email protected]",
   "password": "secret"
}

Response: 200 OK

Response body:

{
   "name": "John",
   "lastname": "Doe",
   "email": "[email protected]",
}

Example 2: a POST request for api/auth/signup

Request body:

{
   "lastname": "Doe",
   "email": "[email protected]",
   "password": "secret"
}

Response: 400 Bad Request

Response body:

{
   "timestamp": "<date>",
   "status": 400,
   "error": "Bad Request",
   "path": "/api/auth/signup"
}

Example 3: a POST request for api/auth/signup

Request body:

{
   "name": "John",
   "lastname": "Doe",
   "email": "[email protected]",
   "password": "secret"
}

Response: 400 Bad Request

Response body:

{
   "timestamp": "<date>",
   "status": 400,
   "error": "Bad Request",
   "path": "/api/auth/signup"
}