MINHAS-NOTAS-API RESTFul

Esta API foi desenvolvida seguindo os padrões REST, e foi feita em conjunto com o projeto Wonder.

Minhas notas é uma aplicação de gerenciamento de notas, sua abordagem é semelhante ao Google Keep. No total há 3 CRUDs, sendo eles seguindo o modelo: USER, NOTE e TAG.

Clique aqui para mais informações sobre o projeto Minhas notas.

💻 Tecnologias

• JavaScript
• Express
• Sequelize
• MySQL
• MVC
• JWT
• Bcrypt
• CORS

🚀 Getting started

Para rodar esta API localmente, é necessério fazer clone do projeto, instalar todas as suas dependências, configurar variáveis de ambiente e configurar o banco de dados localmente.

Requisitos

• Git
• Node
• NPM
• MySQL

Clonando o repositório, instalando as dependências e configurando o banco de dados.

1 - Clonando o repositório

git clone https://github.com/gabriel-augg/wonder-api

2 - Entrando no projeto e instalando dependências

cd minhas-notas-api
git clone https://github.com/gabriel-augg/wonder-api

3 - Configurando o banco de dados

Você deve consultar um video no youtube sobre o tema, pois é mais fácil configurar um banco de dados MySQL pelo youtube.

Configurando variáveis .env

Crie um arquivo .env no raiz do repositório e defina as seguintes variáveis:

PORT=3000

DB_NAME="minhas-notas"

SERVER_USERNAME="root"

SERVER_HOST="localhost"

SERVER_PORT=3306

SERVER_PASSWORD=""

Defina os valores das variáveis de acordo com as suas configurações.

Iniciando o projeto

npm start

📍 API Endpoints​

Para acessar a documentação completa da API clique aqui.

/AUTH

routes	description
POST /auth/signup	retorna o token do usuário logado
POST /auth/signin	retorna o token do usuário logado

/USERS

routes	description
GET /users/checkuser Protegida	retorna os dados do usuário do logado
PUT /users/update Protegida	atualiza a conta e os dados do usuário logado
DELETE /users/delete Protegida	deleta a conta e os dados do usuário logado

/NOTES

routes	description
GET /notes Protegida	retorna todas as notas do usuário logado
POST /notes/create Protegida	cria uma nova nota e retorna os dados da nota criada
PUT /notes/:id/update Protegida	atualiza e retorna os dados atualizados da nota com base no id
DELETE /notes/:id/delete Protegida	deleta a nota com base no id

/TAGS

routes	description
GET /tags Protegida	retorna todas as tags do usuário logado
POST /tags/create Protegida	retorna todas as tags do usuário logado
PATCH /tags/:id/update Protegida	atualiza e retorna os dados atualizados da tag com base no id
DELETE /tags/:id/delete Protegida	deleta a tag com base no id