API REST

Descrição

• API REST simulando o cadastro de alunos de uma escola

Deploy da API

Deploy do FrontEnd

Repositorio do FrontEnd

Tecnologias Ultilizadas

• Bcryptjs
• Cors
• Dotenv
• Express
• Helmet
• Jsonwebtoken
• Banco de dados - Mariadb
• Multer
• Sequelize

EndPoints da Aplicação

Criação de Login

POST - /users

    {
      "nome": "Exemplo",
      "email": "exemplo@dominio.com",
      "password": "senha123"
    }

Autenticação

POST - /tokens

    {
      "email": "exemplo@dominio.com",
      "password": "senha123"
    }

• Resposta

    {
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
    }

• Mandar na header de cada req "Bearer Token"

Editar dados do User & DELETAR

PUT - /users

• Mandar no corpo da req "Bearer Token"

    {
      "nome": "teste de nome",
      "email": "teste@deemail.com",
      "password": ""
    }

DELETE - /users

• Mandar na header de cada req "Bearer Token"

Alunos

• Criação de alunos

POST - /alunos

    {
      "nome": "Aluno",
      "sobrenome": "teste",
      "email": "aluno@aluno.com",
      "idade": "14",
      "peso": "58",
      "altura": "1.70"
    }

Listar todos alunos

GET - /alunos

[
	{
		"id": 17,
		"nome": "Aluno1",
		"sobrenome": "teste1",
		"email": "aluno1@aluno.com",
		"idade": 14,
		"peso": 58,
		"altura": 1.7,
		"Fotos": []
	},
	{
		"id": 19,
		"nome": "Aluno",
		"sobrenome": "teste",
		"email": "aluno@aluno.com",
		"idade": 14,
		"peso": 58,
		"altura": 1.7,
		"Fotos": []
	}
]

Listar um aluno

GET - /alunos/:id

[
  {
    "id": 17,
    "nome": "Aluno1",
    "sobrenome": "teste1",
    "email": "aluno1@aluno.com",
    "idade": 14,
    "peso": 58,
    "altura": 1.7,
    "Fotos": []
  }
]

Editar um aluno

PUT - /alunos/:id

	{
		"nome": "aluno",
		"sobrenome": "teste"
	}

Deletar um aluno

DELETE - /alunos/:id

• Resposta

	{
    "Aluno deletado"
  }

Cadastrar Foto do Aluno

POST - /fotos

• Mandar um formulário MULTIPART

Ultilização do projeto

Clonar o repositório

git clone https://github.com/edsuuu/api_escola.git

Acessar a pasta do repositorio

cd api_escola

Instalar as Dependencias

npm install

Configurar as variáveis de ambiente .env

• Se estiver usando o linux

sudo nano .env

• Variáveis para o banco MariaDB

DB_NAME=
DB_HOST=
DB_PORT=
DB_USERNAME=
DB_PASSWORD=

APP_PORT=

TOKEN_SECRET=1d
TOKEN_EXPIRATION=

Rodar as Migrações

sequelize db:migrate

• Remover as Migrações

sequelize db:migrate:undo

Iniciar o projeto Local

npm run dev