viniciusr-cmd / fornecedores-api

Desenvolvimento de uma API-Rest em NODE.JS utilizando EXPRESS.

Descrição:

Aplicação BACK-END que gerencia e automatiza uma rotina de fornecedores de uma loja de informática. Para isso foi utilizado o banco de dados relacional SQLite, com o padrão do tipo REST e como organizador de conceitos, o MVC.

Ferramentas utilizadas:

Para o desenvolvimento, foi utilizado JavaScript com NodeJS, e Express como Framework, além do banco de dados relacional SQLite e hospedagem pela Heroku.

Dependências necessárias:

"dependencies": {
    "chalk": "^4.1.2",
    "consign": "^0.1.6",
    "cors": "^2.8.5",
    "dotenv": "^10.0.0",
    "express": "^4.17.1",
    "sqlite3": "^5.0.2"
  }

As Dependências podem ser encontradas AQUI do qual o trecho acima foi extraído, para instalar basta rodar o comando abaixo selecionando e copiando o mesmo com as teclas Ctrl + C e em seguida colar no terminal com as telas Ctrl + Shift + V, o comando abaixo já irá fazer o clone deste repositório e instalar as Dependências necessárias.

git clone https://github.com/viniciusr-cmd/fornecedores-api.git && cd fornecedores-api && npm install

Dependências de desenvolvimento:

"devDependencies": {
    "nodemon": "^2.0.15"
  }

Em outra parte do Arquivo de configuração é possível encontrar o código acima que foi extraído do mesmo, essas são as Dependências necessárias para o ambiente de desenvolvimento da aplicação, caso deseje instalar utilize os comandos abaixo em seu terminal logo após o comando das Dependências obrigatórias.

npm install --save-dev nodemon

Inicialização da aplicação via terminal:

Para inicio da aplicação basta abrir o terminal na pasta do projeto ou executar o código abaixo.

npm start

Observação importante:

A versão NODE.JS utilizada para desenvolvimento é a 16.x LTS, logo é necessário instalação de versão igual ou superior para a perfeita execução da mesma.

Rotas da API:

Temos a rota raiz "/fornecedores" onde podemos utilizar todos os métodos CRUD, tais como Create, Read, Update, Delete.

Ver todos os fornecedores:

Utilizar o método HTTP GET no caminho "URL" + /fornecedores

Buscar fornecedores por id:

Utilizar o método HTTP GET no caminho "URL" + /fornecedores/id

Adicionar fornecedores:

Utilizar o método HTTP POST no caminho "URL" + /fornecedores com todos os dados necessários para o seu banco de dados. Segue abaixo o exemplo para o corpo da requisição.

    {
        "ENDERECO": "Taipei, Taiwan",
        "NOME_DO_FORNECEDOR": "ASUS",
        "FRETE_POR_KM": "00.00"
    }

Modificar um fornecedor já existente:

Utilizar o método HTTP PATCH no caminho "URL" + /fornecedores/:id passando os valores que deseja alterar especificando seus devidos campos. Para isso basta respeitar a sintaxe json novamente, passada abaixo no corpo da requisição.

    {
        "ENDERECO": "Taipei, Taiwan",
        "NOME_DO_FORNECEDOR": "ASUS",
        "FRETE_POR_KM": "10.00"
    }

Deletar um fornecedor:

Utilizar o método HTTP DELETE no caminho "URL" + /fornecedores/:id.

Exemplo de GET na Interface do POSTMAN

+ OBS 2: Caso você apague o arquivo do banco de dados sem querer, rode o comando abaixo para criar outro novamente, mas atenção, esse novo banco virá vazio, apenas com a linha 1 contendo o exemplo dos tipos de dados aceitos nele.

node ./src/infra/create-database.js