🌟 Bem-vindo à API de Produtos. Esta API permite executar operações CRUD (Criar, Ler, Atualizar e Deletar) em uma lista de produtos. Para facilitar a integração e os testes, disponibilizamos uma documentação interativa no Postman, onde é possível explorar todas as funcionalidades, incluindo rotas e exemplos de requisições.
( Clique aqui para saber mais da documentação)
- Instalação
- Instruções
- Observações
- Clone o repositório:
git clone https://github.com/seu-usuario/nome-do-repositorio.git
- Navegue até o diretório do projeto:
cd nome-do-repositorio
- Instale as dependências:
npm install express fetch filesystem joi dotenv winston
- OBS: Foi instalado a Biblioteca Joi para validação de dados.
- Inicie o servidor:
npm run nodemon
- Que vai já estar no
package.json
- O servidor será iniciado em http://localhost:3000.
🔊 Para acessar os produtos, adicione '/api/products' ao final da URL (http://localhost:3000) e atualize a página.
👉 Para começar a usar a API, acesse o link do Postman
: (https://www.postman.com/),
✨ Esta API
permite experimentar as seguintes ações:
➕ Criar Produtos: Use `POST/api/products`em (json) para aicionar novos celulares ao catálogo 📲
Exemplo de produtos:
{
"title": "iPhone 16 Pro",
"description": "O iPhone 16 Pro apresenta um design elegante com bordas retas e está equipado com o poderoso chip A18 Pro,
proporcionando desempenho excepcional.",
"quantity": 10,
"price": 7.999,
}
🔍 Listar Produtos: Faça uma requisição (`GET/api/products`) para consultar o catálogo completo.
😃 Listar Produtos: Use `GET /api/products/:id` para uma requisição para consultar um produto específico.
✏️ Atualizar Produtos: Use `PUT /api/products/:id``modificando informações dos produtos existentes com uma requisição 📈
🗑️ Excluir Produtos: Use `DELETE /api/products/:id` e remova produtos do catálogo, mantendo-o sempre atualizado ❌
Para testar a API, você pode usar ferramentas como o Postman ou curl. A API está configurada para rodar localmente na porta 3000, mas você pode definir uma porta diferente configurando a variável de ambiente PORT. O servidor retornará uma mensagem de erro 404 se o item não for encontrado para as requisições GET, PUT ou DELETE.
Tecnologias utilizadas no projeto:
JavaScript (JS)
"Linguagem de Programação do Navegador". "Scripting Dinâmico para Web".
Node.js
"Ambiente de Execução JavaScript do Lado do Servidor". "Servidor Escalável em JavaScript".
Express.js
"Framework Web Minimalista para Node.js". "Backend Rápido para Aplicações Web".
fs
- "Módulo de Sistema de Arquivos para Node.js". "Manipulação de Arquivos de Forma Eficiente no Servidor".`
Vercel (para deploy)
-"Plataforma para Deploy Automático de Aplicações Web".- "Hospedagem e Escalabilidade para Frontend e Backend".
Postman
"Ferramenta de Teste de API para Desenvolvedores". "Simulação e Automação de Requisições HTTP".
Git
"Sistema de controle de versões"
Github
"Plataforma para hospedagem de código-fonte"
Visual Studio Code
"Editor de código-fonte"
- Esse projeto está sob a licença MIT.
RafaelRaizer-Dev
Whatsapp | LinkedIn | GitHub| Tableau| Portfólio