Code Monkey home page Code Monkey logo

api_escola's Introduction

API REST

Descrição

  • API REST simulando o cadastro de alunos de uma escola

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": "[email protected]",
      "password": "senha123"
    }

Autenticação

POST - /tokens

    {
      "email": "[email protected]",
      "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": "[email protected]",
      "password": ""
    }

DELETE - /users

  • Mandar na header de cada req "Bearer Token"

Alunos

  • Criação de alunos

POST - /alunos

    {
      "nome": "Aluno",
      "sobrenome": "teste",
      "email": "[email protected]",
      "idade": "14",
      "peso": "58",
      "altura": "1.70"
    }

Listar todos alunos

GET - /alunos

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

Listar um aluno

GET - /alunos/:id

[
  {
    "id": 17,
    "nome": "Aluno1",
    "sobrenome": "teste1",
    "email": "[email protected]",
    "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

api_escola's People

Contributors

edsuuu avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.