vinisooo / contact-book-api

Contact Book is an application that allows you to manage contacts. With this application, you can easily and conveniently add, view, edit, and delete contacts.

Documentação - Contact Book API

Rodando Localmente

1. Clone o repositório:

   git clone https://github.com/vinisooo/contact-book-api.git

2. Navegue até o diretório do projeto:

   cd contact-book-api

3. Instale as dependências do projeto utilizando o npm:

   npm install

4. Inicie a API localmente:

   npm run dev

5. Pronto! Agora a API deverá estar rodando localmente na porta 3001

   http://localhost:3001

6. Acesse o front-end do projeto:

   Ver repositório
   Acessar front-end do projeto

Registro de Usuário

Endpoint: POST /users/register

Envio:

    {
      "name": "user",
      "email": "[e-mail]",
      "phone": "[phone]",
      "password": "password123"
    }
  

Resposta:

    {
      "id": 1,
      "name": "user",
      "email": "[e-mail]",
      "phone": "[phone]",
      "createdAt": "2023-05-30"
    }
  

Receber Usuário Logado

Endpoint: GET /users/logged/:id

Parâmetros:

• id (número) - ID do usuário logado
• Token (string) - Token de autenticação

Exemplo de resposta:

    {
      "id": 1,
      "name": "user",
      "email": "[e-mail]",
      "password": "$2a$10$toa3ha4.Hg6ZN0/ijYNkhelzHstHKC3Gn6i4fUwuOBbhYd1rEEu1m",
      "phone": "[phone]",
      "createdAt": "2023-05-27",
      "contacts": []
    }
  

Obter Usuários

Endpoint: GET /users

Resposta:

    [
      {
        "id": 2,
        "name": "user1",
        "email": "[e-mail]",
        "phone": "[phone]",
        "createdAt": "2023-05-28"
      },
      {
        "id": 3,
        "name": "user2",
        "email": "[e-mail]",
        "phone": "[phone]",
        "createdAt": "2023-05-28"
      }
    ]
  

Obter Usuário por ID

Endpoint: GET /users/:id

Parâmetros:

• id (número) - ID do usuário

Exemplo de resposta:

    {
      "id": 1
      "name": "user",
      "email": "[e-mail]",
      "phone": "[phone]",
      "createdAt": "2023-05-24"
    }
  

Deletar Usuário por ID

Endpoint: DELETE /users/:id

Parâmetros:

• id (número) - ID do usuário logado
• Token (string) - Token de autenticação

Resposta: 204 No Content

Atualizar Usuário

Endpoint: PATCH /users/:id

Parâmetros:

• id (número) - ID do usuário logado
• Token (string) - Token de autenticação

Corpo da requisição:

    {
      "name": "updated User",
      "email": "[e-mail]",
      "phone": "[phone]"
    }
  

Exemplo de resposta:

    {
      "id": 7,
      "name": "updated User",
      "email": "[e-mail]",
      "phone": "[phone]",
      "createdAt": "2023-05-30"
    }
  

Obter Contatos do Usuário

Endpoint: GET /users/:id/contacts

Parâmetros:

• id (número) - ID do usuário logado
• Token (string) - Token de autenticação

Exemplo de resposta:

    [
      {
        "id": 2,
        "name": "contact1",
        "email": "[e-mail]",
        "phone": "[phone]",
        "createdAt": "2023-05-30"
      },
      {
        "id": 3,
        "name": "contact2",
        "email": "[e-mail]",
        "phone": "[phone]",
        "createdAt": "2023-05-30"
      }
    ]
  

Criar Contato

Endpoint: POST /contacts

Parâmetros:

• Token (string) - Token de autenticação

Corpo da requisição:

    {
      "name": "contact",
      "phone": "[phone]",
      "email": "[e-mail]"
    }
  

Exemplo de resposta:

    {
      "name": "contact",
      "email": "[e-mail]",
      "phone": "[phone]",
      "user": {
        "id": 1,
        "name": "user",
        "email": "[e-mail]",
        "phone": "[phone]",
        "createdAt": "2023-05-30"
      },
      "id": 2,
      "createdAt": "2023-05-30"
    }
  

Obter Contato Específico

Endpoint: GET /contacts/:id

Parâmetros:

• id (número) - ID do contato
• Token (string) - Token de autenticação do dono do contato

Exemplo de resposta:

    {
      "id": 3,
      "name": "contact",
      "email": "[e-mail]",
      "phone": "[phone]",
      "createdAt": "2023-05-30",
      "user": {
        "id": 1,
        "name": "user",
        "email": "[e-mail]",
        "phone": "[phone]",
        "createdAt": "2023-05-30"
      }
    }
  

Atualizar Contato Específico

Endpoint: PATCH /contacts/:id

Parâmetros:

• id (número) - ID do contato
• Token (string) - Token de autenticação do dono do contato

Corpo da requisição:

    {
      "name": "updated contact",
      "email": "[e-mail]",
      "phone": "[phone]"
    }
  

Exemplo de resposta:

    {
      "id": 3,
      "name": "updated contact",
      "email": "[e-mail]",
      "phone": "[phone]",
      "createdAt": "2023-05-30",
      "user": {
        "id": 1,
        "name": "user",
        "email": "[e-mail]",
        "phone": "[phone]",
        "createdAt": "2023-05-30"
      }
    }
  

Deletar Contato

Endpoint: DELETE /contacts/:id

Parâmetros:

• id (número) - ID do contato
• Token (string) - Token de autenticação do dono do contato

Resposta: 204 No Content