Este projeto API CRUD que tem como objetivo melhorar o gerenciamento de usuários.
API-CADASTRO
│
├── node_modules
├── src
│ ├── config
│ │ ├── corsConfig.js
│ ├── controller
│ │ ├── user.controller.js
│ ├── database
│ │ ├── config.js
│ │ ├── database-sqlite.db
│ ├── docs
│ │ ├── swaggerConfig.js
│ │ ├── swaggerDocs.js
│ │ └── user.yaml
│ ├── models
│ │ └── user.models.js
│ ├── router
│ │ └── user.router.js
├── test
│ ├── jest.config.js
│ └── user.spec.js
├── .babelrc
├── .env
├── .gitignore
├── app.js
├── jest.config.js
├── package-lock.json
├── package.json
|
└── README.md
- 📦 Node.js
- 🐬 Sequelize
- 🌐 Cors
- 🧪 Jest
- ♻️ Babel
- 📧 Nodemailer
- 🚀 Express
-
Clone o repositório:
git clone https://github.com/souzalipe/Api-Cadastro
-
Navegue até o diretório do projeto:
cd Api-Cadastro
-
Instale as dependências:
npm install
- npm start run
-
Rota: GET /
-
Descrição: Mostra os usários ja cadastrados.
-
Corpo da Requisição: json
{ "name": "valor", "age": valor, }
-
Resposta:
[ { "id_user": 1, "name": "João Silva", "age": "25", }, { "id_user": 2, "name": "Maria Souza", "age": "63", } ]
-
Rota: POST /user
-
Descrição: Adiciona um novo usuário
-
Corpo da Requisição:
{ "name": "Nome do Usuário", "age": "Idade do Usuário", }
-
Resposta:
{ "affectedRows": 1, "insertId": valor, "message": "Usuário adicionado com sucesso!" }
- Rota: GET /read/:id
- Descrição: Retorna as um usuário com o id.
- Resposta:
{ "id_user": 1, "name": "João Silva", "age": "25", }
- Rota: PUT /update/:id
- Descrição: Atualiza usuário com base no id.
- Corpo da requisição:
{ "name": "Nome Atualizado", "age": "Idade Atualizada", }
- Resposta:
{ "affectedRows": 1, "message": "Usuário atualizado com sucesso!" }
- Rota: DELETE /delete/:id
- Descrição: Exclui um usuário pelo ID.
- Resposta:
{ "id_user": 1, "nome": "João Silva", "age": "25", }
Se desejar contribuir com o projeto, siga os passos abaixo:
- Fork o projeto.
- Crie uma nova branch com sua feature:
git checkout -b minha-feature
. - Commit suas alterações:
git commit -m 'Minha nova feature'
. - Push para a branch:
git push origin minha-feature
. - Abra um Pull Request.