O propósito desse projeto é ter um backend sólido e bem documentado para servir de base para exercícios de desenvolvimento de frontend.
Trata-se de um backend que disponibiliza endpoints úteis para o desenvolvimento de um sistema de gestão de contatos. Foi desenvolvida aplicando conceitos da Clean Architecture em TypeScript.
Os endpoints permitem que os usuários possam se cadastrar e adicionar contatos com emails e números de telefone.
API disponível em https://contatos-api.fly.dev/api/v1/
A documentação da API: https://sergiomoura.github.io/contatos-api/
Demo HTML Template: https://sergiomoura.github.io/contatos-html-template/
Repositório HTML template: https://github.com/sergiomoura/contatos-html-template
Url Base: https://contatos-api.fly.dev/api/v1/
Método HTTP | Endpoint | Descrição |
---|---|---|
POST | /auth/register | Utilizado para cadastro de usuário |
POST | /auth/login | Utilizado para autenticação do usuário |
GET | /contacts | Retorna todos os contatos do usuário |
POST | /contacts | Cria novo contato para usuário |
DELETE | /contacts/{contactId} | Remove um contato cadastrado |
POST | /contacts/{contactId}/emails | Cria novo e-mail para contato |
DELETE | /contacts/{contactId}/emails/{emailId} | Remove e-mail de contato |
POST | /contacts/{contactId}/phones | Cria novo telefone para contato |
DELETE | /contacts/{contactId}/emails/{phoneId} | Remove telefone de contato |
Para contribuir com o projeto, siga as instruções abaixo:
- Faça um fork deste repositório
- Crie uma branch com a feature ou correção que deseja implementar:
git checkout -b minha-feature
- Faça as alterações necessárias e adicione testes
- Faça o commit das suas alterações:
git commit -m 'Implementando minha feature'
- Faça o push para a sua branch:
git push origin minha-feature
- Crie um Pull Request para o repositório original. -->
Você pode abrir uma issue caso note algum mal funcionamento sinta falta de alguma funcionalidade. O modelo abaixo não é obrigatório, mas pode guiar você para que forneça todas as informações necessárias para a resolução. ´´´
## Descrição do Problema
[Descreva aqui o problema ou tarefa em questão]
## Etapas para reproduzir o problema (se aplicável)
[Se o problema estiver relacionado a um bug, forneça etapas claras para reproduzir o problema]
1. [Etapa 1]
2. [Etapa 2]
3. [Etapa 3]
...
## Comportamento esperado (se aplicável)
[Descreva o comportamento esperado do sistema ou da funcionalidade em questão]
## Comportamento atual (se aplicável)
[Descreva o comportamento atual do sistema ou da funcionalidade em questão]
## Capturas de tela (se aplicável)
[Se possível, inclua capturas de tela para ilustrar o problema ou a tarefa]
## Solução proposta (se aplicável)
[Se você tiver uma solução proposta para o problema ou tarefa, descreva-a aqui]
## Etiquetas
[Adicione as etiquetas relevantes para esta issue, como "bug", "feature", "documentation", etc.]