lukasveiga / employee-rest-api Goto Github PK

• Employee's Rest API

This API consists of a simple employee management application, containing information about first name, last name, and email. It is possible to perform all CRUD operations (Create, Read, Update, and Delete) on the database through the endpoints.

The main focus of this API is to develop skills in back-end structure development using the Spring Boot framework, including clean code best practices, SOLID principles, layer pattern, and unit and integration testing.

• Java 17;
• Spring Boot;
• MySQL;
• Maven;

1. Get a list of all employees:

  http://localhost:8080/api/v1/employees

2. Get employee by id (e.g. id = 1):

  http://localhost:8080/api/v1/employees/1

3. Get employee by first name (e.g. name = "John"):

  http://localhost:8080/api/v1/employees/first-name?name=John

4. Add new employee:

  http://localhost:8080/api/v1/employees
  
  Request json body:
  
  {
    "firstName": "Carl",
    "lastName": "Sagan",
    "email": "[email protected]"
  }

5. Update existing employee (e.g. id = 1):

  http://localhost:8080/api/v1/employees/1
  
  Request json body:
  
  {
    "firstName": "Carl",
    "lastName": "Sagan",
    "email": "[email protected]"
  }

6. Delete existing employee (e.g. id = 1):

  http://localhost:8080/api/v1/employees/1
  
  Response:
  
  Employee Carl Sagan was deleted.

1. Go to the directory that you would like to clone the repository;
2. Clone the repository and create a local copy following the command above:

  git clone https://github.com/Lukasveiga/employee-rest-api.git

3. Insert que file application.properties in the resources folder in the main directory with the following spring configuration to setup the MySQL database:

 spring.datasource.url=jdbc:mysql://localhost:3306/{database}
 spring.datasource.username={username}
 spring.datasource.password={password}

Replace {database} with the database name, {username} with username and {password} with password without the {}.

4. And run with IDE of your choice or maven command lines.

• Linkedin;
• e-mail: [email protected];