API para conectar a Landapage da Localiza com o banco de dados MS SQL. Com essa API poderam consultar, adicionar, editar, apagar e contar clientes no banco de dados. Para executar a API terá que seguir as instruções abaixo:
- Clonar o repositório
- Executar o comendo (npm install) para instalar as dependencias
- Criar arquivo .env e adicionar as variáveis de conexão com o banco de dados MS SQL Server
- npm run dev - Executa a API como modo de desenvolvimento
- npm run build - Faz o build da API
- npm run start - Executa a API após terminar o build
- SQL_SERVER - IP ou Server Name onde o servidor MS SQL esta rodando
- SQL_USER - Usuário do banco de dados
- SQL_PASSWORD - Senha de acesso do usuário
- SQL_DATABASE - Nome do banco de dados à ser utilizado
- SQL_PORT - Porta que o banco de dados esta utilizando (opcional, não implementado)
- SQL_ENCRYPT - Se o banco de dados estiver em servidores da Microssoft Azure passar para true
Neste arquivo é o responsável por pegar as variáveis de sistema e exporta-las para a aplicação.
Arquivo de conexão com o banco de dados
Arquivo utilizado pelo plugin REST Client do VS Code para poder testar as requisições
A tabela clients e os campos name e email são obrigatório para o funcionamento da API
Tenho mais um campo na tabela que se chama created_at (datetime), que sempre que um registro é criado, é inserido a data e hora da criação do registro
A API responde todas as requisições com a mesma rota e alguns parâmetros que cito abaixo.
- Listar todos os Clientes:
- http://<Domínio>/clients
- Método GET
- Listar um Cliente especifico:
- http://<Domínio>/clients/
- Método GET
- Adicionar Novo CLiente:
- http://<Domínio>/clients
- Método POST
- Envio data via json
- Alterar um Cliente:
- http://<Domínio>/clients/
- Método PUT
- Envio Data via json
- Apagar um Cliente:
- http://<Domínio>/clients/
- Método DELETE
- Mostrar número total de Clientes
- http://<Domínio>/clients/count
- Método GET