Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ludson96/project-blogs-api

Projeto para estudo de API RestFul com Node.js usando o pacote sequelize para fazer CRUD, e JWT para autenticação
https://github.com/ludson96/project-blogs-api

crud docker docker-compose express javascript jwt jwt-authentication mysql node-js nodejs orm sequelize

Last synced: about 2 months ago
JSON representation

Projeto para estudo de API RestFul com Node.js usando o pacote sequelize para fazer CRUD, e JWT para autenticação

Host: GitHub
URL: https://github.com/ludson96/project-blogs-api
Owner: Ludson96
Created: 2022-12-22T16:11:07.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-01-05T18:59:42.000Z (about 2 years ago)
Last Synced: 2023-03-03T23:49:35.601Z (almost 2 years ago)
Topics: crud, docker, docker-compose, express, javascript, jwt, jwt-authentication, mysql, node-js, nodejs, orm, sequelize
Language: JavaScript
Homepage:
Size: 331 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Repositório do projeto Blogs API 📝
## Módulo: BACK-END

Repositório possui projeto desenvolvido no período que estive na Trybe, abordando os conceitos de RESTFul API com CRUD completo utilizando arquitetura Model-Service-Controller (MSC).
## Informações de aprendizados
- Este é um projeto desenvolvido para me ajudar a aprender sobre `sequelize` e `JWT`;
- Meu primeiro projeto usando `sequelize` e `JWT`;
- Utilizei o Cliente Rest `Thunder Client`, como extensão, para visualizar o retorno do meu acesso.
## Linguagem usadas

[![JavaScript][JavaScript-logo]][JavaScript-url]
[![NodeJS][NodeJS-logo]][NodeJS-url]
[![Express][Express-logo]][Express-url]
[![MySQL][MySQL-logo]][MySQL-url]
[![Sequelize][Sequelize-logo]][Sequelize-url]
[![JWT][JWT-logo]][JWT-url]
[![Docker][Docker-logo]][Docker-url]
[![.ENV][.ENV-logo]][.ENV-url]
[![Nodemon][Nodemon-logo]][Nodemon-url]
[![ESLint][ESLint-logo]][ESLint-url]
## O que foi desenvolvido

Uma API e um banco de dados, utilizando a arquitetura MSC (model-service-controller), para a produção de conteúdo para um blog!

1. Desenvolvi endpoints que estarão conectados ao banco de dados seguindo os princípios do REST;

2. Para fazer um post é necessário usuário e login, portanto foi trabalhada a relação entre user e post;

3. Será necessária a utilização de categorias para os posts, trabalhando, assim, a relação de posts para categories e de categories para posts.

> `docker-compose.yml`, `config.js` e `/seeders` arquivos providos pela Trybe.

## Variáveis de Ambiente

Para rodar esse projeto, atente-se as variáveis de ambiente no seu .env. Existe um arquivo `.env.example` com as informações para configuração.
## Instruções para instalar e rodar

1. Clone o repo:
```
git clone [email protected]:Ludson96/project-blogs-api.git
```
2. Já existe um arquivo docker-compose.yml. Bastando usar o comando docker-compose up para rodar o MySQL e o Node pelo docker. Execute os services do docker: `node` e `db`
```
docker-compose up -d
```
3. Inicie o container node (renomeado para blogs_api):
```
docker exec -it blogs_api bash
```
4. Instale as suas dependências:
```
npm install
```
5. Execute o servidor:

```
npm start
```
Outra forma de executar é utilizando o `nodemom` (permite fazer alteração em tempo real sem precisar derrubar o servidor e iniciá-lo novamente):
```
npm run debug
```
6. Utilizar alguma Plataforma de API para acessar os endpoints e fazer seus devidos experimentos. Exemplos: Postman e Insomnia. Ou uma extensão no VSCode, recomendo utilizar a thunder client.

7. Uso

- utilize o comando `npm run prestart`, ele criará o banco de dados e as tabelas de acordo com o que está em `/migrations` e `/seeders` .

- Todas as rotas (exceto `post /login` e `post /user` ) requerem autenticação
## Diagrama

![Diagrama de relacionamentos das tabelas](diagrama.png)

> _Imagem disponibilizada pela Trybe_
## Endpoints

### Rota de Login

#### POST `/login`
- Entrar
- O corpo deve ser o seguinte:
```json
{
"email" : " [email protected] " ,
"senha" : " 123456 "
}
```
- Retorna um token se o login for concluído

### Rota do Usuário

#### POST `/usuário`
- Cria um novo usuário
- O corpo deve ser o seguinte, onde:
- `displayName` deve ter pelo menos 8 caracteres
- `email` deve ter um formato válido
- `password` deve ter pelo menos 6 caracteres
- `imagem` é opcional
```json
{
"displayName" : " John Doe " ,
"email" : " [email protected] " ,
"senha" : " 123456 " ,
"image" : " https://cdn1.iconfinder.com/data/icons/users-solid-1/30/users-solid-profile-neutral-5-512.png "
}
```
- Se o usuário for criado com sucesso, um token é fornecido

#### GET `/usuário`
- Lista todos os usuários:
```json
[
{
"id" : 1 ,
"displayName" : " Lewis Hamilton " ,
"email" : " [email protected] " ,
"image" : " https://upload.wikimedia.org/wikipedia/commons/1/18/Lewis_Hamilton_2016_Malaysia_2.jpg "
},
/* ... */
]
```

#### GET `/user/:id`
- Pega um parâmetro numérico, e se houver algum usuário com id correspondente, retorna:
```json
{
"id" : 3 ,
"displayName" : " John Doe " ,
"email" : " [email protected] " ,
"image" : " https://cdn1.iconfinder.com/data/icons/users-solid-1/30/users-solid-profile-neutral-5-512.png "
}
```

#### DELETE `/user/me`
- Exclui o usuário atual
- Se o usuário for excluído com sucesso, o status `204` é retornado

### Categorias Rota

#### POST `/categorias`
- Cria uma nova categoria
- O corpo deve ser o seguinte:
```json
{
"name" : " Truques de mágica "
}
```

#### GET `/categorias`
- Lista todas as categorias:
```json
[
{
"id" : 1 ,
"nome" : " Animais "
},
{
"id" : 2 ,
"nome" : " Livros "
},
/* ... */
]
```

### Pós Rota

#### POST `/post`
- Cria uma nova postagem no blog
- O corpo deve ser o seguinte:
```json
{
"title" : " Resenha: A arte da columbofilia " ,
"content" : " Este é um ótimo livro sobre como os pombos podem ser treinados para se tornarem campeões! " ,
"categoryIds" : [ 1 , 2 ]
}
```

#### GET `/post`
- Lista todas as postagens do blog:
```json
[
{
"id" : 1 ,
"title" : " As melhores raças de cães para caça " ,
"content" : " Aqui estão os melhores companheiros de caça " ,
"userId" : 1 ,
"publicado" : " 2011-08-01T19:58:00.000Z " ,
"atualizado" : " 2011-08-01T19:58:51.000Z " ,
"usuário" : {
"id" : 1 ,
"displayName" : " Lewis Hamilton " ,
"email" : " [email protected] " ,
"image" : " https://upload.wikimedia.org/wikipedia/commons/1/18/Lewis_Hamilton_2016_Malaysia_2.jpg "
},
"categorias" : [
{
"id" : 1 ,
"nome" : " Animais "
}
]
},

/* ... */
]
```

#### GET `/post/:id`
- Pega um parâmetro numérico, e se houver algum post com um id correspondente, retorna:
```json
{
"id" : 1 ,
"title" : " As melhores raças de cães para caça " ,
"content" : " Aqui estão os melhores companheiros de caça " ,
"userId" : 1 ,
"publicado" : " 2011-08-01T19:58:00.000Z " ,
"atualizado" : " 2011-08-01T19:58:51.000Z " ,
"usuário" : {
"id" : 1 ,
"displayName" : " Lewis Hamilton " ,
"email" : " [email protected] " ,
"image" : " https://upload.wikimedia.org/wikipedia/commons/1/18/Lewis_Hamilton_2016_Malaysia_2.jpg "
},
"categorias" : [
{
"id" : 1 ,
"nome" : " Animais "
}
]
}
```

#### GET `/post/search?q=:searchTerm`
- Pesquisa postagens por título ou conteúdo, por exemplo:
```json
// GET /post/search?q=silk
[
{
"id" : 2 ,
"title" : " Ótimos livros sobre a Rota da Seda " ,
"content" : " Estes são alguns livros obrigatórios sobre a Rota da Seda " ,
"userId" : 1 ,
"publicado" : " 2011-08-01T19:58:00.000Z " ,
"atualizado" : " 2011-08-01T19:58:51.000Z " ,
"usuário" : {
"id" : 1 ,
"displayName" : " Lewis Hamilton " ,
"email" : " [email protected] " ,
"image" : " https://upload.wikimedia.org/wikipedia/commons/1/18/Lewis_Hamilton_2016_Malaysia_2.jpg "
},
"categorias" : [
{
"id" : 2 ,
"nome" : " Livros "
}
]
}
]
```
- Se não houver parâmetro de consulta, retorna todos os posts:
```json
// GET /post/search?q=
[
{
"id" : 1 ,
"title" : " As melhores raças de cães para caça " ,
"content" : " Aqui estão os melhores companheiros de caça " ,
"userId" : 1 ,
"publicado" : " 2011-08-01T19:58:00.000Z " ,
"atualizado" : " 2011-08-01T19:58:51.000Z " ,
"usuário" : {
"id" : 1 ,
"displayName" : " Lewis Hamilton " ,
"email" : " [email protected] " ,
"image" : " https://upload.wikimedia.org/wikipedia/commons/1/18/Lewis_Hamilton_2016_Malaysia_2.jpg "
},
"categorias" : [
{
"id" : 1 ,
"nome" : " Cães "
}
]
},

/* ... */
]
```

#### COLOQUE `/post/:id`
- Edita uma postagem existente
- O corpo deve ser o seguinte, onde:
- não é possível alterar a categoria
- somente o **autor** pode editar a postagem
```json
{
"title" : " Como fazer crescer as plantas da sua casa " ,
"content" : " Este é um guia passo a passo para melhorar o crescimento de plantas em ambientes internos "
}
```

#### APAGAR `/post/:id`
- Exclui uma postagem existente
- Somente o autor pode deletar o post
- Se a postagem for excluída com sucesso, retorna o status `204`

[JavaScript-logo]: https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E
[JavaScript-url]: https://www.javascript.com/
[NodeJS-logo]: https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white
[NodeJS-url]: https://nodejs.org/en/
[Docker-logo]: https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white
[Docker-url]: https://www.docker.com
[MySQL-logo]: https://img.shields.io/badge/mysql-%2300f.svg?style=for-the-badge&logo=mysql&logoColor=white
[MySQL-url]: https://www.mysql.com
[Express-logo]: https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge&logo=express&logoColor=%2361DAFB
[Express-url]: https://expressjs.com
[Sequelize-logo]: https://img.shields.io/badge/Sequelize-52B0E7?style=for-the-badge&logo=Sequelize&logoColor=white
[Sequelize-url]: https://sequelize.org
[JWT-logo]: https://img.shields.io/badge/JWT-black?style=for-the-badge&logo=JSON%20web%20tokens
[JWT-url]: https://jwt.io/
[Nodemon-logo]: https://img.shields.io/badge/Nodemon-76D04B?logo=nodemon&logoColor=fff&style=for-the-badge
[Nodemon-url]: https://www.npmjs.com/package/nodemon
[ESLint-logo]: https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white
[ESLint-url]: https://eslint.org/
[.ENV-logo]: https://img.shields.io/badge/.ENV-ECD53F?logo=dotenv&logoColor=000&style=for-the-badge
[.ENV-url]: https://www.npmjs.com/package/dotenv