PeopleManager API

A Rest API that helps you to manage people register 🚀

📌 Table of Contents

Features
Requirements
Installation
Getting Started
FAQ
Found a bug? Missing a specific feature?
Contributing
License

🚀 Features

CREATE
READ
UPDATE
DELETE

Sample Valid JSON Request Body

Create -> /api/v1/people

[
  {
    "id": 1,
    "firstName": "Guilherme",
    "lastName": "Rodrigues",
    "cpf": "369.333.878-79",
    "birthDate": "24-03-1990",
    "phones": [
      {
        "id": 1,
        "type": "MOBILE",
        "number": "(11)999999999"
      }
    ]
  }
]

Requirements

For building and running the application you need:

JDK 11
Maven

👷 Installation

To install this application, run the following commands:

git clone https://github.com/iamgrodrigues/peoplemanager-api.git

If you have a SSH key registered in your Github account, clone the project using this command:

git clone git@github.com:iamgrodrigues/peoplemanager-api.git

🏃 Getting Started

Running the application locally

There are several ways to run a Spring Boot application on your local machine. One way is to execute the main method in the one.digitalinnovation.peopleapi.PeopleapiApplication class from your IDE.

Alternatively you can use the Spring Boot Maven plugin like so:

mvn spring-boot:run

After the above command, you can navigate to the following address to see the project up and runnig:

http://localhost:8080/api/v1/people

Status Codes

PeopleManager returns the following status codes in its API:

Status Code	Description
200	`OK`
201	`CREATED`
204	`NO CONTENT`
400	`BAD REQUEST`
404	`NOT FOUND`
500	`INTERNAL SERVER ERROR`

📮 Faq

Question: What are the tecnologies used in this project?

Answer: The tecnologies used in this project are Java + Spring Boot.

🐛 Issues

Feel free to file a new issue with a respective title and description on the the PeopleManager API repository. If you already found a solution to your problem, I would love to review your pull request! Have a look at our contribution guidelines to find out about the coding standards.

🎉 Contributing

Check out the contributing page to see the best places to file issues, start discussions and begin contributing.

📕 License

Released in 2021. This project is under the MIT license.

Made with love by Guilherme Rodrigues 💚🚀