/crud-users-api

🚀 Rest api that enables crud of users.

Primary LanguageTypeScript

💻 How work ?

# Clone this repository
$ git clone https://github.com/KaikySantos/crud-users-api.git
# Access the project folder
$ cd crud-users-api

📦 Rode a API

# Install the dependencies
$ yarn install

# Run the application
$ yarn start
# I recommend installing insomnia:
https://insomnia.rest/download/

🚀 Functionalities:

CRUD (CREATE, READ, UPDATE, DELETE)

Read:

HTTP PATH DESCRIPTION
GET /users List all registered users.

Create:

HTTP PATH DESCRIPTION
POST /users Register new user.

Observation: It is necessary to send a JSON with this structure:

{
	"name": "",
	"phone": "",
	"email": ""
}

Update:

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": ""
}

Delete:

HTTP PATH DESCRIPTION
PUT /users/{user_id} Deletes a specific user.