Academia Fit API

Projeto educacional do curso de Web Dev Full Stack da Resilia Educação referente ao Módulo 04, utilizando o Node.js com framework Express.
Explore os arquivos do projeto. »

Gostaria de ajudar? Me envie uma sugestão ou melhoria.

Conteúdo sobre a documentação.

1. Sobre o projeto
2. Como instalar e iniciar o projeto
3. Contato

Sobre o Projeto

O objetivo proposto como projeto final do módulo 4, é criar uma API Rest de uma Academia. Criei a entidade 'Agendamentos' e com ela você poderá realizar as operações básicas CRUD, que são elas:

• Ler todos os agendamentos do banco de dados, ou, filtrar um agendamento por ID ou por nome do cliente.
• Criar um novo agendamento na academia.
• Deletar um agendamento pelo número do ID.
• Atualizar um ou vários dados de um agendamento.

Tecnologias, pacotes e frameworks utilizados ⚙️

• JavaScript
• Node.js v16.14.0
• NPM v8.3.1
• Express v4.17.3
• Nodemon v2.0.15
• SQLite v5.0.2

Como instalar e iniciar 🏁

Este é um exemplo sobre como instalar e configurar seu projeto localmente. Para fazer uma cópia local e iniciar, siga estas etapas de exemplo simples.

Pré-Requisitos

Lembre-se do que você irá precisará ter instalado em sua máquina para executar o prejeto. 👇

1. Instale NPM

   npm install

Instalação

Abra o terminal/Powershell e rode os comandos abaixo:

Para clonar o repositório:

  git clone https://github.com/karinacristo/projetoAcademiaAPI.git

Acesse a pasta criada:

cd projetoAcademiaAPI

Para iniciar os projetos use o comando abaixo

npm run dev

Rotas e seus resultados

Ao executar a entidade agendamentos, aparecerá os atributos adicionados à ela, que são: id, cliente, data, profissional, período, serviço e observações. Veja os resultados:

• Método GET para visualizar todos os agendamentos marcados. ( /agendamentos)

Schema da resposta.

{
  "Agendamento": [
    {
     "Id_cliente": (string),
     "Cliente": (string),
     "Data": (string),
     "Profissional": (string),
     "Período": (string),
     "Serviço": (string),
     "Observações": (string),
    }
  ]

• Método GET para filtrar um dado por ID ( /agendamentos/ID_CLIENTE/{o número de ID})

Schema da resposta.

{
  "Agendamento": [
    {
     "Id_cliente": (string),
     "Cliente": (string),
     "Data": (string),
     "Profissional": (string),
     "Período": (string),
     "Serviço": (string),
     "Observações": (string),
    }
  ],
  "Erro": (booleano)

• Método GET para filtrar um dado por nome de um cliente ( /agendamentos/cliente/{o nome do cliente})

Schema da resposta.

{
  "Agendamento": [
    {
     "Id_cliente": (string),
     "Cliente": (string),
     "Data": (string),
     "Profissional": (string),
     "Período": (string),
     "Serviço": (string),
     "Observações": (string),
    }
  ],
  "Erro": (booleano)

• Método POST para adicionar um novo agendamento ( /agendamentos)

Para adicionar, segue o esquema: "cliente" : "", "data" : "", "profissional" : "", "período" : "", "serviço" : "", "observações" : ""

Schema da resposta.

{
  "Mensagem": (string),
  "Erro": (booleano)
 }

• Método DELETE para apagar um agendamento por ID ( /agendamentos/ID_CLIENTE/{o número de id})

Schema da resposta.

{
  "Mensagem": (string),
  "Erro": (booleano)
  }

• Método PUT para atualizar um agendamento por ID ( /agendamentos/ID_CLIENTE/{o número de id})

Schema da resposta.

{
	"Mensagem": (string),
	"Agendamento": {
		"Cliente": (string),
		"Data": (string),
		"Período": (string),
		"Serviço": (string),
		"Observações": (string)
	},
	"Erro": (booleano)
}

Contato 📝

Karina Cristo - Linkedin - GitHub