🏗️ Build Setup

Primeiramente, abre seu melhor terminal e acesse a pasta ao qual você clonou o repositório.

Ao fazer isso, rode o seguinte comando no terminal:

  npm install

Após o install, necessário criar a migrate com o seguinte comando no terminal:

  npm prisma migrate dev

Para finalizar, rode o seguinte comando no terminal:

  npm run dev

Feito isso, em seu terminal você receberá o seguinte feedback:

  Server is running on port 3100

Caso deseje visualizar seu banco, rode o seguinte comando:

  npm prisma studio

🚀 Rotas

A API de Agenda de Contatos possui as seguintes rotas:

Users: /users

Criação de usuário

• Método: POST;
• Rota: /;
• Corpo da requisição:
  • name: string;
  • email: string;
• Resposta:
  • id: string;
  • name: string;
  • email: string;

Contacts: /contacts

[!IMPORTANT] Necessário autenticação, para tal, adicionar o campo email no headers da requisição com o email do usuário

Listagem de contatos

• Método: GET;
• Rota: /;
• Corpo da requisição:
  • email: string;
  • phone: string;
• Resposta:
  • Listagem com os seguintes campos:
    • id: string;
    • name: string;
    • email: string;
    • phone: string;
    • userId: string;

Criação de contatos

• Método: POST;
• Rota: /;
• Corpo da requisição:
  • name: string;
  • email: string;
  • phone: string;
• Resposta:
  • id: string;
  • name: string;
  • email: string;
  • phone: string;
  • userId: string;

Edição de contatos

• Método: PUT;
• Rota: /:id_contato;
• Corpo da requisição:
  • name: string;
  • email: string;
  • phone: string;
• Resposta:
  • id: string;
  • name: string;
  • email: string;
  • phone: string;
  • userId: string;

Exclusão de contatos

• Método: DELETE;
• Rota: /:id_contato;
• Resposta:
  • boolean;

💻 Implementações futuras

• Autenticação com JWT;
• Validação para criação de usuário;
• Validação dos campos para edição e criação de contatos;

📝 Licença

MIT License © Atyson Jaime