Rosemary’s Tattoo Studio API 🌹

Introdução

Projeto de encerramento de módulo 4 do Resilia Educação. Consiste na montagem de uma API REST, baseada no tema escolhido pelo grupo e a distribuição das entidades entre os integrantes.

Esta API se foca na entidade Funcionários, contendo seus dados e sendo possível realizar operações CRUD.

---

Pré-requistos

• Node.js v.16.14.0
• NPM v.8.3.1

Pacotes utilizados

• Express v.4.17.3
• Nodemon v.2.0.15
• SQLite v.5.0.0
• Cors v.2.8.5
• Bcrypt v.5.0.1

---

Instalação da aplicação

Abra o terminal/Powershell e rode os comandos abaixo:

Clonando o repositório:

git clone git@github.com/lesantxs/rosemarys_api.git 

Entrando na pasta:

cd rosemarys_api

Instalando os pacotes:

npm install

Criando e populando banco de dados:

npm run database

Iniciando o servidor:

npm start

---

Rotas implementadas

Obs.: servidor http://localhost:3000/

Funcionário

• GET /funcionarios 

  Retorna os dados de todos os funcionários.

  Schema da resposta:

  {
      funcionarios: [
          {
              "id": <String>,
              "nome": <String>,
              "cargo": <String>,
              "email": <String>,
              "senha": <String>,
              "status": <String>,
              "admissao": <String>
          }
      ],
      erro: <Boleano>
  }
  

• GET /funcionario/id/{id}

  Retorna os dados de somente um funcionário.

  Schema da resposta:

  {
      funcionarios: [
          {
              "id": <String>,
              "nome": <String>,
              "cargo": <String>,
              "email": <String>,
              "senha": <String>,
              "status": <String>,
              "admissao": <String>
          }
      ],
      erro: <Boleano>
  }
  

• GET /funcionario/email/{email}

  Retorna os dados de somente um funcionário.

  Schema da resposta:

  {
      funcionarios: [
          {
              "id": <String>,
              "nome": <String>,
              "cargo": <String>,
              "email": <String>,
              "senha": <String>,
              "status": <String>,
              "admissao": <String>
          }
      ],
      erro: <Boleano>
  }
  

• POST /funcionario

  Adiciona dados de um novo funcionário.

  Schema da requisição:

  {
     "nome": <String>,
     "cargo": <String>,
     "email": <String>,
     "senha": <String>,
     "status": <String>
  }
  

  Schema da resposta:

  {
      mensagem: <String>
      funcionario: {
          "nome": <String>,
          "cargo": <String>,
          "email": <String>,
          "senha": <String>,
          "status": <String>
      },
      erro: <Boleano>
  }
  

• PUT /funcionario/funcionario/{id}

  Atualiza os dados de um funcionário.

  Schema da requisição:

  {
      "nome": <String>,
      "cargo": <String>,
      "email": <String>,
      "senha": <String>,
      "status": <String>
  }
  

  Schema da resposta:

  {
      mensagem: <String>
      funcionario: {
          "nome": <String>,
          "cargo": <String>,
          "email": <String>,
          "senha": <String>,
          "status": <String>
      }
      erro: <Boleano>
  }
  

• DELETE /funcionario/id/{id}

  Deleta os dados de um funcionário.

  Schema da resposta:

  {
      mensagem: <String>
      erro: <Boleano>
  }
  

---

Elaboração

Projeto realizado por Letícia Santos do Carmo

Confira também

API Agenda

API Estoque

API Portifólio