paulorgs / contele-teste

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

contele-teste

Descrição

API desenvolvida com Typescript,NodeJS e Express

Endpoints

HTTP ROUTE BODY DESCRIÇÃO
GET /api/v1/users Listar todos usuarios
GET /api/v1/users/user_id Listar único usuário
POST /api/v1/users JSON { "email":"usuario@exemplo.com", "password":"senha"} Criar único usuário
PUT /api/v1/users/user_id JSON { "email":"usuario@exemplo.com", "password":"senha"} Alterar um único usuário
DELETE /api/v1/users Remover todos usuarios
DELETE /api/v1/users/user_id Remover único usuário

Instalação e Execução

  • Baixe o projeto em sua máquina diretamente ou então utilizando o comando git clone https://github.com/paulorgs/contele-teste

  • Entre na pasta do projeto e execute o comando yarn ou então npm install e aguarde a instalação dos pacotes.

  • Execute o comando yarn dev:start ou então npm run dev:start caso tenha utilizado NPM para realizar a instalação.

  • Utilize um cliente REST como Postman ou Insomnia para realizar as requisições.

About


Languages

Language:TypeScript 98.5%Language:JavaScript 1.5%