Skip to content

saulgdev/API-FindClient

Repository files navigation

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

Description

Projeto FindClient - Api

Tecnologias utilizadas no projeto:

Instalando Dependências

Clone o projeto em sua máquina e instale as dependências com o comando:

$ npm install

Execute as migrations com o comando:

$ npm run migration:run

Variáveis de Ambiente

Em seguida, crie um arquivo .env, copiando o formato do arquivo .env.example:

cp .env.example .env

Configure suas variáveis de ambiente com suas credenciais do Postgres e uma nova database da sua escolha.

Endpoints

A API possui os seguintes endpoints:

Clientes

GET /clientes

Retorna todos os clientes cadastrados.

GET /clientes/:id

Retorna um cliente específico pelo ID.

POST /clientes

Cadastra um novo cliente.

PUT /clientes/:id

Atualiza os dados de um cliente existente pelo ID.

DELETE /clientes/:id

Remove um cliente pelo ID.

Contatos

Todas as rotas de contato precisam ter o token para autenticação!!!

GET /clientes/:id/contatos

Retorna todos os contatos de um cliente específico pelo ID.

GET /clientes/:id/contatos/:idContato

Retorna um contato específico de um cliente pelo ID do cliente e do contato.

POST /clientes/:id/contatos

Cadastra um novo contato para um cliente específico pelo ID.

PUT /clientes/:id/contatos/:idContato

Atualiza os dados de um contato existente de um cliente pelo ID do cliente e do contato.

DELETE /clientes/:id/contatos/:idContato

Remove um contato de um cliente pelo ID do cliente e do contato.

Exemplos de requisição e resposta

GET /clientes/:id/contatos/:idContato

About

Api projetada em NestJS + TypeScript

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published