API de conexão com o BD da Domínio, para o cliente FLEM
API que consome requisições das aplicações FLEM para o Banco de Dados de terceiros (Domínio Sistemas).
- Objetivo
- Características
- Especificações
- Stack
- Documentação
- Como usar este repositório
- Notas de versão
- Autores
- Contato
- Licença
- Fornecer uma API de alta performance e baixo custo computacional que consuma de maneira segura e estável os dados requisitados;
- Manipular de maneira independente e com controle integrado dados provenientes do BD da Domínio.
- Facilita os processos resumindo todas as suas funcionalidades centradas no consumo dos dados sem comprometer a performance.
- Tipo de Software: Interface de Programação de Aplicações
- Distribuição: Web
- Arquitetura: MVC
- Metodologia de Projeto: Metodologia Ágil
- Estrutura de Biblioteca: Baseada em Framework
- Protocolo de Banco de Dados: ODBC
- Dialeto de Banco de Dados: SQL
- Disponibilidade de Código: Open Source
- Linguagem Principal: Javascript
- Framework Principal: Node.js
- Framework estrutural: Next.js
- Biblioteca de Conexão ODBC: Sybase-Promised
- Gerenciador de Bibliotecas: Yarn
- Bibliotecas: Para uma lista completa de bibliotecas e dependências nos mais variados escopos, conferir o arquivo package.json.
Confira a documentação completa aqui.
1 - Faça um git clone ou o download do repositório, da forma que preferir
git clone https://github.com/frtechdev/flem-bd-dominio-api.git
2 - Instale um gerenciador de pacotes (preferencialmente yarn) utilizando um terminal no diretório raiz do repositório clonado
yarn ou npm install
3 - Execute a aplicação no terminal
yarn dev ou npm run dev
Para testar a aplicação, crie um arquivo .env com as seguintes variáveis de ambiente:
| Variável | Uso |
|---|---|
DB_HOST= |
Define o endereço do Servidor de Banco de Dados Sybase |
DB_PORT= |
Define a porta de conexão ao Servidor |
DB_DBNAME= |
Define o nome do Banco de Dados |
DB_USERNAME= |
Define o nome de usuário de acesso ao Banco de Dados |
DB_PASSWORD= |
Define a senha de acesso ao Banco de Dados |
- Atualização da Documentação
- Correção do método POST em api/funcionarios para inclusão dos critérios de filtragem
- Implementação da biblioteca Forever para gerenciamento do processo Node a fim de que este reinicialize em caso de erro com o conector Sybase
- Alteração do parâmetro de script "yarn dev" para inicializar uma instância Forever invocando a aplicação
- Adição de parâmetro de script "yarn stop" para finalizar corretamente o processo-filho do Forever e contornar o bug do Node no Windows
- Atualização da Documentação
- Adição de método POST para critérios de condições longas
- Atualização do GITIGNORE
- Adição de comando yarn para realizar o contorno do update do caniuse (browserslist update)
- Atualização do README
- Alteração na API para utilizar um único queryComposer
- Ajuste nos utilitários de conversão de array para o queryComposer
- Atualização da documentação
- Atualização da documentação
- Remoção do utilitário de composição da query de cada controller e agrupado em um utilitário específico
- Criados controllers para query de afastamentos e de beneficiários
- Atualização da documentação
- Atualização da documentação
- Atualização do GITIGNORE
- Modificação do controller de busca de funcionários para uma melhor organização entre as funções e as queries
- Criação de um controller para pesquisa de histórico de férias, ausências e licenças de funcionários
- Criação de um controller para pesquisa de dados de beneficiários dentre os dados dos funcionários
- Criação de rota API para busca de dados de beneficiários, afastamentos e lista geral
- Resolvido bug de performance causado pela desconexão mal resolvida do Sybase-Promised
- Criado componente específico para armazenamento de queries realizadas pelos controllers
- Reformulação das queries para trazer informações mais legíveis e completas
- Criado componente para parametrizar fragmentos condicionais das queries (CASE, IF)
- Acrescentados utilitários
- Revisados utilitários de manipulação de array
- Revisados métodos de composição de filtro de pesquisa de query dos controllers
- Atualização da documentação
- Remoção do CHANGELOG e inclusão no README
- Adição de arquivos .env e yarn lock ao gitignore
- Adição de configurações de linting
- Removidos dados de versão no Changelog
- Remoção do template da API
- Atualização da documentação
- Atualização dos parâmetros jsdoc para compilação da documentação
- Ajustes ao next coinfig para direcionamento automático de rota para alteração de Home Page da API
- Remoção do parâmetro de porta de conexão separadamente em arquivo .env e retorno da menção da porta pelo script do package.json
- Criação de Controller para manipulação e aquisição de dados
- Alteração da Rota de API para pesquisas de funcionários
- Implementação de função para controller customizado utilizando filtros de critério de pesquisa
- Criada função para alteração do título da Home Page da documentação visto limitação da biblioteca jsdoc
- Implementado método para aplicar CORS dentro da rota
- Implementada função de query ao BD utilizando o conector do Sybase
- Adicionados e revisados utilitários de máscaras e parsers
- v0.0.4-220322rl
- Efetuado criação da rota 'Funcionário' para consulta de dados do colaborador pela matrícula
- v0.0.2-220228fr
- v0.0.1-220228dx
- v0.0.1-220228dx
- Criação do README
- Criação do CHANGELOG
- Recompilação da documentação inicial
Se você gostou desse projeto, nos dê uma estrela. Isso agirá como um indicador da qualidade dos nossos serviços.
Para contato, envie um email a: [email protected]
Licenciado sob a MIT License.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent