Introdução
Este guia destina-se aos desenvolvedores internos da Ponto-On que estão envolvidos no desenvolvimento e manutenção da API de gerenciamento de ponto para empresas. Ele fornece uma visão geral da arquitetura da API, as tecnologias utilizadas, as boas práticas de desenvolvimento e os procedimentos de teste.Arquitetura da API
A API de gerenciamento de ponto para empresas da Ponto-On é desenvolvida seguindo uma arquitetura RESTful. Ela consiste em uma série de endpoints que permitem às empresas realizar operações relacionadas ao registro de ponto dos seus colaboradores, como registro de entrada e saída, ajustes de horário, e consulta de relatórios.Tecnologias Utilizadas
A API é desenvolvida utilizando o framework NestJS, que é baseado no Node.js. O banco de dados utilizado é o PostgreSQL para armazenamento dos dados relacionais e o Redis para armazenamento de cache e sessões.Boas Práticas de Desenvolvimento
- Padrões de Codificação: Seguir as convenções de codificação e estilo definidas pela equipe de desenvolvimento.
- Documentação: Manter a documentação da API atualizada e completa, utilizando o padrão OpenAPI.
- Segurança: Implementar medidas de segurança, como autenticação e autorização, para proteger os dados sensíveis dos usuários.
- Testes Unitários e de Integração: Escrever testes unitários e de integração para garantir a qualidade e robustez do código.
- Controle de Versão: Utilizar um sistema de controle de versão, como o Git, para gerenciar o código-fonte e as mudanças no projeto.
Procedimentos de Teste
Antes de enviar qualquer alteração para produção, é importante realizar uma série de testes para garantir que o código funciona conforme esperado e não introduza regressões ou problemas de segurança. Isso inclui:- Testes Unitários: Verificar se cada função ou método individual funciona corretamente.
- Testes de Integração: Testar a interação entre diferentes componentes da aplicação.
- Testes de API: Testar os endpoints da API para garantir que eles respondam corretamente e retornem os dados esperados.
- Testes de Performance: Avaliar o desempenho da API sob carga e identificar possíveis gargalos ou pontos de melhoria.