# Clone this repository
$ git clone https://github.com/KaikySantos/crud-users-api.git
# Access the project folder
$ cd crud-users-api
# Install the dependencies
$ yarn install
# Run the application
$ yarn start
# I recommend installing insomnia:
https://insomnia.rest/download/
CRUD (CREATE, READ, UPDATE, DELETE)
HTTP |
PATH |
DESCRIPTION |
GET |
/users |
List all registered users. |
HTTP |
PATH |
DESCRIPTION |
POST |
/users |
Register new user. |
Observation: It is necessary to send a JSON with this structure:
{
"name": "",
"phone": "",
"email": ""
}
HTTP |
PATH |
DESCRIPTION |
PUT |
/users/{user_id} |
Edit an already registered user. |
Observation: It is necessary to send a JSON with this structure:
{
"name": "",
"phone": "",
"email": ""
}
HTTP |
PATH |
DESCRIPTION |
PUT |
/users/{user_id} |
Deletes a specific user. |