GitHub - RasecMH/trybe-blogs-api: A aplicação se trata de uma API para um blog, capaz de criar e autenticar usuários, criar e editar postagens e categorias fazendo conexão com um banco de dados SQL.

Este projeto foi desenvolvido durante o curso de Desenvolvimento Web Full Stack da Trybe com o objetivo de reforçar meus aprendizados de Javascript, Docker, NodeJs, Express, MySQL, Sequelize e Arquitetura MSC.

A aplicação se trata de uma API para um blog, capaz de criar e autenticar usuários, criar e editar postagens e categorias fazendo conexão com um banco de dados SQL.

Para rodar o projeto:

git clone [email protected]:RasecMH/trybe-blogs-api.git

cd trybe-blogs-api

Localmente (Necessário Node e MySQL instalados na máquina):
```
npm install
```
```
npm start
```

Docker (APP_PORT: 3000 | MYSQL_PORT: 3306):

docker-compose up -d --build

docker exec -it blogs_api bash

npm install

npm start

Rotas

/login

POST

Corpo da requisição

  {
    "email": "[email protected]",
    "password": "123456"
  }

Em caso de sucesso retorna com status 200:

  {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjo1LCJkaXNwbGF5TmFtZSI6InVzdWFyaW8gZGUgdGVzdGUiLCJlbWFpbCI6InRlc3RlQGVtYWlsLmNvbSIsImltYWdlIjoibnVsbCJ9LCJpYXQiOjE2MjAyNDQxODcsImV4cCI6MTYyMDY3NjE4N30.Roc4byj6mYakYqd9LTCozU1hd9k_Vw5IWKGL4hcCVG8"
  }

Em caso de campos vazios retorna com status 400:

  {
    "message": "Some required fields are missing"
  }

Em caso de campos inválidos retorna com status 400:
```
  {
    "message": "Invalid fields"
  }
```

/user

GET

Em caso de sucesso retorna com status 200:

    [
      {
          "id": 1,
          "displayName": "Lewis Hamilton",
          "email": "[email protected]",
          "image": "https://upload.wikimedia.org/wikipedia/commons/1/18/Lewis_Hamilton_2016_Malaysia_2.jpg"
      },
      /* ... */
    ]

[Messagens de validação de token JWT]
- caso o token não seja encontrado no parametro Authorization da requisição retorna com status 401:
```
  {
    "message": "Token not found"
  }
```
- caso o token esteja expirado ou seja inválido retorna com status 401:
```
  {
    "message": "Expired or invalid token"
  }
```

POST

Corpo da requisição

  {
    "displayName": "Brett Wiltshire",
    "email": "[email protected]",
    "password": "123456",
    "image": "http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png"
  }

Em caso de sucesso retorna com status 201:

  {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjo1LCJkaXNwbGF5TmFtZSI6InVzdWFyaW8gZGUgdGVzdGUiLCJlbWFpbCI6InRlc3RlQGVtYWlsLmNvbSIsImltYWdlIjoibnVsbCJ9LCJpYXQiOjE2MjAyNDQxODcsImV4cCI6MTYyMDY3NjE4N30.Roc4byj6mYakYqd9LTCozU1hd9k_Vw5IWKGL4hcCVG8"
  }

Caso campo displayName tenha menos de 8 caracteres retorna com status 400:

  {
    "message": "\"displayName\" length must be at least 8 characters long"
  }

Caso o campo email não esteja no formato correto retorna com status 400:
```
  {
    "message": "\"email\" must be a valid email"
  }
```

Caso o campo password tenha menos de 6 caracteres retorna com status 400:

  {
    "message": "\"password\" length must be at least 6 characters long"
  }

Caso o email já esteja cadastrado no banco de dados retorna com status 409:
```
  {
    "message": "User already registered"
  }
```

/user/:id

GET

Em caso de sucesso retorna com status 200:

    {
      "id": 1,
      "displayName": "Lewis Hamilton",
      "email": "[email protected]",
      "image": "https://upload.wikimedia.org/wikipedia/commons/1/18/Lewis_Hamilton_2016_Malaysia_2.jpg"
    }

Caso o usuário não exista no banco de dados retorna com status 404:
```
    {
      "message": "User does not exist"
    }
```
[Messagens de validação de token JWT]
- caso o token não seja encontrado no parametro Authorization da requisição retorna com status 401:
```
  {
    "message": "Token not found"
  }
```
- caso o token esteja expirado ou seja inválido retorna com status 401:
```
  {
    "message": "Expired or invalid token"
  }
```

/user/me

DELETE

Em caso de sucesso retorna status 204
[Messagens de validação de token JWT]
- caso o token não seja encontrado no parametro Authorization da requisição retorna com status 401:
```
  {
    "message": "Token not found"
  }
```
- caso o token esteja expirado ou seja inválido retorna com status 401:
```
  {
    "message": "Expired or invalid token"
  }
```

/categories

GET

Em caso de sucesso retorna com status 200:

  [
    {
        "id": 1,
        "name": "Inovação"
    },
    {
        "id": 2,
        "name": "Escola"
    },
    /* ... */
  ]

[Messagens de validação de token JWT]
- caso o token não seja encontrado no parametro Authorization da requisição retorna com status 401:
```
  {
    "message": "Token not found"
  }
```
- caso o token esteja expirado ou seja inválido retorna com status 401:
```
  {
    "message": "Expired or invalid token"
  }
```

POST

Corpo da requisição
```
  {
    "name": "Typescript"
  }
```

Em caso de sucesso retorna com status 201:

  {
    "id": 3,
    "name": "Typescript"
  }

Caso o campo name esteja vazio ou invalido retorna com status 400:
```
  {
    "message": "\"name\" is required"
  }
```
[Messagens de validação de token JWT]
- caso o token não seja encontrado no parametro Authorization da requisição retorna com status 401:
```
  {
    "message": "Token not found"
  }
```
- caso o token esteja expirado ou seja inválido retorna com status 401:
```
  {
    "message": "Expired or invalid token"
  }
```

/post

GET

Em caso de sucesso retorna com status 200:

  [
    {
      "id": 1,
      "title": "Post do Ano",
      "content": "Melhor post do ano",
      "userId": 1,
      "published": "2011-08-01T19:58:00.000Z",
      "updated": "2011-08-01T19:58:51.000Z",
      "user": {
        "id": 1,
        "displayName": "Lewis Hamilton",
        "email": "[email protected]",
        "image": "https://upload.wikimedia.org/wikipedia/commons/1/18/Lewis_Hamilton_2016_Malaysia_2.jpg"
      },
      "categories": [
        {
          "id": 1,
          "name": "Inovação"
        }
      ]
    },
    
    /* ... */
  ]

[Messagens de validação de token JWT]
- caso o token não seja encontrado no parametro Authorization da requisição retorna com status 401:
```
  {
    "message": "Token not found"
  }
```
- caso o token esteja expirado ou seja inválido retorna com status 401:
```
  {
    "message": "Expired or invalid token"
  }
```

POST

Corpo da requisição

  {
    "title": "Latest updates, August 1st",
    "content": "The whole text for the blog post goes here in this key",
    "categoryIds": [1, 2]
  }

Em caso de sucesso retorna com status 201:

  {
    "id": 3,
    "title": "Latest updates, August 1st",
    "content": "The whole text for the blog post goes here in this key",
    "userId": 1,
    "updated": "2022-05-18T18:00:01.196Z",
    "published": "2022-05-18T18:00:01.196Z"
  }

Caso algum campo esteja vazio retorna com status 400:

  {
    "message": "Some required fields are missing"
  }

Caso nenhuma das categorias passadas no campo categoryIds exista no banco de dados retorna com status 400:
```
  {
    "message": "\"categoryIds\" not found"
  }
```
[Messagens de validação de token JWT]
- caso o token não seja encontrado no parametro Authorization da requisição retorna com status 401:
```
  {
    "message": "Token not found"
  }
```
- caso o token esteja expirado ou seja inválido retorna com status 401:
```
  {
    "message": "Expired or invalid token"
  }
```

/post/search

GET

Pesquisa filtra pelos campos title e content, caso nada seja passado, retorna todas as postagens.

Em caso de sucesso retorna com status 200:

  // GET /post/search?q=
  [
    {
      "id": 1,
      "title": "Post do Ano",
      "content": "Melhor post do ano",
      "userId": 1,
      "published": "2011-08-01T19:58:00.000Z",
      "updated": "2011-08-01T19:58:51.000Z",
      "user": {
        "id": 1,
        "displayName": "Lewis Hamilton",
        "email": "[email protected]",
        "image": "https://upload.wikimedia.org/wikipedia/commons/1/18/Lewis_Hamilton_2016_Malaysia_2.jpg"
      },
      "categories": [
        {
          "id": 1,
          "name": "Inovação"
        }
      ]
    },
    
    /* ... */
  ]

Caso não exista nenhuma postagem com o termo pesquisado retorna com status 200:
```
  // GET /post/search?q=BATATA
  []
```
[Messagens de validação de token JWT]
- caso o token não seja encontrado no parametro Authorization da requisição retorna com status 401:
```
  {
    "message": "Token not found"
  }
```
- caso o token esteja expirado ou seja inválido retorna com status 401:
```
  {
    "message": "Expired or invalid token"
  }
```

/post/:id

GET

Em caso de sucesso retorna com status 200:

  {
    "id": 1,
    "title": "Post do Ano",
    "content": "Melhor post do ano",
    "userId": 1,
    "published": "2011-08-01T19:58:00.000Z",
    "updated": "2011-08-01T19:58:51.000Z",
    "user": {
        "id": 1,
        "displayName": "Lewis Hamilton",
        "email": "[email protected]",
        "image": "https://upload.wikimedia.org/wikipedia/commons/1/18/Lewis_Hamilton_2016_Malaysia_2.jpg"
    },
    "categories": [
        {
            "id": 1,
            "name": "Inovação"
        }
    ]
  }

Caso a postagem não exista no banco de dados retorna com status 404:
```
  {
    "message": "Post does not exist"
  }
```
[Messagens de validação de token JWT]
- caso o token não seja encontrado no parametro Authorization da requisição retorna com status 401:
```
  {
    "message": "Token not found"
  }
```
- caso o token esteja expirado ou seja inválido retorna com status 401:
```
  {
    "message": "Expired or invalid token"
  }
```

PUT

Corpo da requisição

  {
    "title": "Latest updates, August 1st",
    "content": "The whole text for the blog post goes here in this key"
  }

Em caso de sucesso retorna com status 200:

  {
    "id": 3,
    "title": "Latest updates, August 1st",
    "content": "The whole text for the blog post goes here in this key",
    "userId": 1,
    "published": "2022-05-18T18:00:01.000Z",
    "updated": "2022-05-18T18:07:32.000Z",
    "user": {
      "id": 1,
      "displayName": "Lewis Hamilton",
      "email": "[email protected]",
      "image": "https://upload.wikimedia.org/wikipedia/commons/1/18/Lewis_Hamilton_2016_Malaysia_2.jpg"
    },
    "categories": [
      {
        "id": 1,
        "name": "Inovação"
      },
      {
        "id": 2,
        "name": "Escola"
      }
    ]
  }

Caso algum dos campos da requisição esteja vazio retorna com status 400:
```
  {
    "message": "Some required fields are missing"
  }
```
Caso a postagem não pertença ao usuário autenticado retorna com status 401:
```
  {
    "message": "Unauthorized user"
  }
```
[Messagens de validação de token JWT]
- caso o token não seja encontrado no parametro Authorization da requisição retorna com status 401:
```
  {
    "message": "Token not found"
  }
```
- caso o token esteja expirado ou seja inválido retorna com status 401:
```
  {
    "message": "Expired or invalid token"
  }
```

DELETE

Em caso de sucesso retorna status 204
Caso a postagem não pertença ao usuário autenticado retorna com status 401:
```
  {
    "message": "Unauthorized user"
  }
```
Caso a postagem não exista no banco de dados retorna com status 404:
```
  {
    "message": "Post does not exist"
  }
```
[Messagens de validação de token JWT]
- caso o token não seja encontrado no parametro Authorization da requisição retorna com status 401:
```
  {
    "message": "Token not found"
  }
```
- caso o token esteja expirado ou seja inválido retorna com status 401:
```
  {
    "message": "Expired or invalid token"
  }
```

Name		Name	Last commit message	Last commit date
Latest commit History 90 Commits
api		api
.eslintignore		.eslintignore
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
.sequelizerc		.sequelizerc
Dockerfile		Dockerfile
README.md		README.md
docker-compose.yml		docker-compose.yml
jest.config.js		jest.config.js
package-lock.json		package-lock.json
package.json		package.json
vercel.json		vercel.json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

Rotas

/login

/user

/user/:id

/user/me

/categories

/post

/post/search

/post/:id

About

Uh oh!

Releases

Packages

Uh oh!

Contributors 3

Uh oh!

Languages

RasecMH/trybe-blogs-api

Folders and files

Latest commit

History

Repository files navigation

Rotas

/login

/user

/user/:id

/user/me

/categories

/post

/post/search

/post/:id

About

Topics

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors 3

Uh oh!

Languages

Packages