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

O projeto consiste em uma API que realiza um CRUD (Create, Read, Update e Delete) de posts de blog
https://github.com/lucasam1992/project-blogs-api

api-rest crud-api expressjs jsonwebtoken mysql nodejs orm sequelizejs

Last synced: 8 months ago
JSON representation

O projeto consiste em uma API que realiza um CRUD (Create, Read, Update e Delete) de posts de blog

• Host: GitHub
• URL: https://github.com/lucasam1992/project-blogs-api
• Owner: lucasam1992
• Created: 2021-12-14T22:24:16.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-04-19T20:02:33.000Z (almost 4 years ago)
• Last Synced: 2025-06-05T19:49:35.418Z (9 months ago)
• Topics: api-rest, crud-api, expressjs, jsonwebtoken, mysql, nodejs, orm, sequelizejs
• Language: JavaScript
• Homepage:
• Size: 2.77 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Boas vindas ao repositório do API de Blogs!

 O projeto consiste em uma API que realiza um CRUD (Create, Read, Update e Delete) de posts de blog. Para criação das tabelas do banco de dados, foi utilizado a técnica de Mapeamento Objeto-Relacional (`ORM`) através do pacote `sequelize` do Node.js. Foram feitas autenticações de usuários através do pacote `jsonwebtoken`.


 A implementação do código foi feita baseada na arquitetura de software MSC (Model-Service-Controller)

 

 ## Banco de Dados do Projeto

 ![Banco Blogs-API](./public/desenhoBD.png)

---

# Tecnologias Usadas

 - Node.js

 - Sequelize

 - Express

 - JavaScript

 - MySQL

 - JsonWebToken

## O que foi desenvolvido

### 1 - Criação do endpoint POST `/user`

![Cadastro com sucesso](./public/cadastrodeusuario.png)

### 2 - Criação do endpoint POST `/login`

![Login com sucesso](./public/logincomsucesso.png)

### 3 - Criação do endpoint GET `/user`

![Listar usuários](./public/listarusuarios.png)

### 4 - Criação do endpoint GET `/user/:id`

![Listar um usuário](./public/listarumusuario.png)

### 5 - Criação do endpoint POST `/categories`

![Criar categoria com sucesso](./public/cadastrarCategoria.png)

### 6 - Criação do endpoint GET `/categories`

![Buscar todas as categoria com sucesso](./public/buscartodascategoriascomsucesso.png)

### 7 - Criação do endpoint POST `/post`

![Criar blogspot com sucesso](./public/criarblogpost.png)

### 8 - Criação do endpoint GET `/post`

![Criar blogspot com sucesso](./public/listarumblogpost.png)

### 9 - Criação do endpoint GET `post/:id`

![Listar um post com sucesso](./public/listarumpostcomsucesso.png)

### 10 - Criação do endpoint PUT `/post/:id`

![blogpost com token inválido](./public/editarpostcomsucesso.png)

### 11 - Criação do endpoint DELETE `post/:id`

![blogpost com token inválido](./public/deletarpostcomsucesso.png)

### 12 - Criação do endpoint DELETE `/user/me`

![Deletar com sucesso](./public/deletarcomsucesso.png)

### 13 - Criação do endpoint GET `post/search?q=:searchTerm`

![blogpost com token inválido](./public/buscarpostpelotitle.png)

![blogpost com token inválido](./public/buscarpostpelocontent.png)

![blogpost com token inválido](./public/listarpostcampovazio.png)

![blogpost com token inválido](./public/listarumpostquenaoexiste.png)

### Rodando o Projeto Localmente

1° `git clone git@github.com:lucasam1992/project-blogs-api.git` - Clone o repositório para sua máquina


2° `cd project-blogs-api` - Entre na pasta do repositório clonado


3° `npm install` - Instale as depedências


4° `npm start` - Execute o programa


**Sugestão: Baixe o programa Insomina para executar cada operação do CRUD: https://snapcraft.io/install/insomnia/ubuntu

#### Conexão com o Banco 

Para que o projeto rode em sua máquina, você deve criar as seguintes variáveis de ambiente:

`host: process.env.HOSTNAME` 


`user: process.env.MYSQL_USER`


`password: process.env.MYSQL_PASSWORD` 


# Autor

   - Lucas Machado