Skip to content

PetExpress API v1.1.0 🐾

Latest

Choose a tag to compare

@igordmouraa igordmouraa released this 31 Oct 16:03
· 6 commits to main since this release

Estamos empolgados em anunciar uma nova atualização da PetExpress API! Esta versão aprimora e expande a funcionalidade da API de Petshop, adicionando recursos de gerenciamento de pets, produtos, carrinho de compras, agendamentos, endereços e autenticação JWT. A API segue uma estrutura modular, inspirada no NestJS, desenvolvida com Node.js e Sequelize para facilitar a manutenção e a escalabilidade.

🚀 Funcionalidades

Funcionalidades Básicas

  • Pets: Cadastro, edição e exclusão, com limite de 15 pets por usuário e validações customizadas.
  • Produtos: Gerenciamento completo de produtos, com classificação por categorias e espécies.
  • Endereços: Até 3 endereços por usuário, com controle de unicidade para cada entrada.
  • Carrinho e Pedidos: Carrinho de compras com cálculo automático de total e criação de pedido após confirmação de pagamento.

Funcionalidades avançadas

  • Login com Google e Cadastro Automático: Após a autenticação com Google pelo Firebase no front-end, a API verifica se o email já está registrado. Se não, cria o usuário no banco e gera um token JWT para autenticação segura e acesso autorizado.
  • Filtros de Produtos: Opções avançadas de filtro por categorias, espécies e preços, facilitando a busca.

🛠 Estrutura do Projeto

A API foi desenvolvida utilizando uma arquitetura modular, com módulos, controladores e serviços, proporcionando uma manutenção mais ágil e organizada. A comunicação com o banco de dados é gerenciada pelo Sequelize, enquanto o uso de tokens JWT e Firebase fortalece a autenticação e a segurança da aplicação.

⚙️ Configuração e Uso

  1. Clone o repositório e navegue até o diretório do projeto:
git clone https://github.com/TypeBlast/projectApi
cd projectApi
  1. Instale as dependências:
    npm install

  2. Configure as variáveis de ambiente (exemplo no arquivo .env.example).

  3. Execute as migrações do banco de dados:
    npx sequelize db:migrate

  4. Inicie o servidor:
    npm start

🚨 Notas Importantes

  • Configuração de Variáveis de Ambiente: Verifique o .env para incluir as credenciais de banco de dados
  • Esta versão inclui autenticação JWT para endpoints sensíveis, e o limite de até 15 pets e 3 endereços por usuário foi adicionado.

📖 Documentação

Acesse a Documentação Oficial para detalhes dos endpoints, formatos de requisição e resposta, e outras instruções..

🔄 Próximos Passos

  • Integração com gateways de pagamento reais.
  • Notificações por e-mail para confirmação de pedidos.
  • Expansão para dashboards e relatórios gerenciais.

Agradecemos por utilizar a API de Petshop! Para dúvidas ou sugestões, abra uma issue no repositório.