An open API service indexing awesome lists of open source software.

https://github.com/zolppy/user-api

Simples API (Application Programming Interface), desenvolvida com Express.js, responsável por prover as quatro operações do CRUD (Create, Read, Update, Delete) para usuários.
https://github.com/zolppy/user-api

api backend backend-api crud expressjs nodejs

Last synced: 3 months ago
JSON representation

Simples API (Application Programming Interface), desenvolvida com Express.js, responsável por prover as quatro operações do CRUD (Create, Read, Update, Delete) para usuários.

Awesome Lists containing this project

README

          


User API














API (Application Programming Interface), desenvolvida com Express.js, responsável por prover as quatro operações do CRUD (Create, Read, Update, Delete) para usuários.



Endpoints da API

GET /users

Retorna a lista completa de usuários cadastrados.

Exemplo de resposta (dados fictícios):


[
{
"id": 1,
"name": "Nome Completo do Usuário Um",
"birthday": "2004/02/12",
"tel": "(11) 92222-3333",
"e-mail": "exemplo-do-email-um@exemplo.com"
},
{
"id": 2,
"name": "Nome Completo do Usuário Dois",
"birthday": "1999/12/30",
"tel": "(21) 91234-4444",
"e-mail": "exemplo-do-email-dois@exemplo.com"
},
{
"id": 3,
"name": "Nome Completo do Usuário Três",
"birthday": "2001/11/11",
"tel": "(44) 94444-4321",
"e-mail": "exemplo-do-email-três@exemplo.com"
}
]

GET /users/:id

Retorna dados de um usuário específico, de acordo com o id.

Exemplo de resposta (dados fictícios):


{
"id": 2,
"name": "Nome Completo do Usuário Dois",
"birthday": "1999/12/30",
"tel": "(21) 91234-4444",
"e-mail": "exemplo-do-email-dois@exemplo.com"
}

POST /users

Cadastra um novo usuário.

PUT /users/:id

Atualiza um usuário específico, de acordo com o id.

DELETE /users/:id

Remove um usuário específico, de acordo com o id.

Configuração do banco de dados

Será necessário alterar as variáveis de ambiente presentes no arquivo .env com sua própria instância de banco de dados PostgreSQL.


DB_HOST=seu_host
DB_PORT=sua_porta
DB_NAME=seu_nome_do_banco
DB_USER=seu_usuário
DB_PASSWORD=sua_senha

Diagrama Entidade-Relacionamento

![Captura de tela_2024-11-03_11-30-34](https://github.com/user-attachments/assets/3c05bcaa-cc3c-4c21-8bb2-9828c443b7ae)