🚧 ApiBlogs 🚀 Finalizado 🚧

Sobre

API Blogs é uma aplicação desenvolvida para gerenciar um site de blogs

Features

Cadastro de usuários, posts, categorias.
Sistema de login através de token criptografados
Atualizar e deletar posts
Sistema de segurança em que apenas o dono do post pode deletar ou editar

## 🛠 Tecnologias

As seguintes ferramentas foram utilizadas na construção do projeto:

Instalar o projeto em sua máquina

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git e Node.js. É necessário ter instalado e configurado o Mysql. Para uma melhor visualização do banco de dados indico a utilização MysqlWorkBench e possuir um editor de código, sugiro o VSCode. Para fazer as requisições nos endpoints recomendo o Postman.

Renomeio o arquivo .env.example para .env e troque as informações para as que foram criadas quando o MySQL foi configurado. Para o JWT_SECRET= coloque alguma frase secreta, sera usado para gerar tokens seguros.

Rodando a aplicação .

# Clone este repositório
# Foi utilizado SSH
$ git clone git@github.com:coutinhomarco/blogs-api.git

# Acesse a pasta do projeto no seu terminal/cmd
$ cd blogs-api

# Instale as dependências
$ npm install

# Execute a aplicação em modo de desenvolvimento
$ npm run allcomand

Métodos

Requisições para a API devem seguir os padrões:

Método	Descrição
`GET`	Retorna informações
`POST`	Utilizado para criar um novos objetos.
`PUT`	Atualiza dados de um objeto ou altera sua situação.
`DELETE`	Remove um objeto do sistema.

Respostas

Código	Descrição
`200`	Requisição executada com sucesso (success).
`201`	Criado com sucesso com sucesso.
`204`	Sem conteúdo.
`400`	Erros de validação ou os campos informados não existem no sistema.
`409`	Conflito com banco de dados
`404`	Registro pesquisado não encontrado (Not found).
`422`	Dados informados estão fora do escopo definido para o campo.

EndPoints

Token

Todas as rotas (menos /user [POST] e /login [POTS]) precisam de token.

Validações

Quando o token não é passado

Request (application/json)
- Headers ()
```
  {           
      
  }
```

Response 401 (application/json)

  {
      message: "Token not found"
  }

Quando o token é invalido ou expirou

Request (application/json)

Headers ()

  {           
      "Authorization": MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx
  }

Response 401 (application/json)

  {
      message: "Expired or invalid token"
  }

Usuários [/user]

Criar /user [POST]

Request (application/json)

body

  {
      "displayName": "zeca pagodinho",
      "email": "zeca@email.com",
      "password": "123456",
      "image": "http://4.bp.blogspot.com/"
  }

Response 201 (application/json, Token fictício)

      {           
          "Authorization": MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx
      }

Quando as validações falham

Caso "displayName" seja passado, deve possuir pelo menos de 8 caracteres.

Request (application/json)

body

  {
      "displayName": "zeca",
      "email": "zeca@email.com",
      "password": "123456",
      "image": "http://4.bp.blogspot.com/"
  }

Response 400 (application/json)

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

Quando "email" não é passado.

Request (application/json)

body

  {
      "displayName": "zeca pagodnho",
      "password": "123456",
      "image": "http://4.bp.blogspot.com/"
  }

Response 400 (application/json)

    {
        "message": "\"email\" is required" 
    }

Quando "email" não tem um formato valido (algo@algo.com).

Request (application/json)

body

  {
      "displayName": "zeca pagodinho",
      "email": "zeca@email",
      "password": "123456",
      "image": "http://4.bp.blogspot.com/"
  }

Response 422 (application/json)

    {
         "message": "\"email\" must be a valid email"
    }

Quando "password" não é passado.

Request (application/json)

body

{
  "displayName": "zeca pagodinho",
  "email": "zeca@email.com",
  "image": "http://4.bp.blogspot.com/"
}

Response 400 (application/json)

    {
        ""message": "\"password\" is required"
    }

Quando "password" possui menos de 6 caracteres.

Request (application/json)

body

  {
    "displayName": "zeca pagodinho",
    "email": "zeca@email.com",
    "password": "1234",
    "image": "http://4.bp.blogspot.com/"
  }

Response 422 (application/json)

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

Listar /user [GET]

Listar todos os usuários salvos no banco de dados /user

Request (application/json)

Headers (Token fictício)

  {           
      "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
  }

Response 200 (application/json)

  [
      {
          "id": 1,
          "displayName": "Lewis Hamilton",
          "email": "lewishamilton@gmail.com",
          "image": "https://upload.wikimedia.org/wikipedia/"
      }
  ]

Listar por id /user/id [GET]

Listar usuários por um id específico /user/1

Request (application/json)

Headers (Token fictício)

    {           
        "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
    }

Response 200 (application/json)

    {
        "id": 1,
        "displayName": "Lewis Hamilton",
        "email": "lewishamilton@gmail.com",
        "image": "https://upload.wikimedia.org/wikipedia"
    }

Quando o usuário não existe /user/5

Response 404 (application/json)

  {
      "message": "User does not exist"
  }

Deletar /post/me [DELETE]

Para deletar seu usuário deve passar user/me

Request (application/json)

Headers (Token fictício)

    {           
        "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
    }

Response 204

Login [/login]

Login /login [POST]

Request (application/json)

Headers (Token fictício)

 {           
     "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
 }

body

  {
      "email": "zeca@email.com",
      "password": "123456"
  }

Response 200 (application/json)

    {           
        "token": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
    }

Listar /categories [GET]

Listar todos as categorias salvas no banco de dados /categories

Request (application/json)

Headers (Token fictício)

 {           
     "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
 }

Response 200 (application/json)

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

Criar /categories [POST]

Criar categoria no banco de dados /categories

Request (application/json)

Headers (Token fictício)

  {           
      "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
  }

body

{ "name" : "cervejinha gelada" }

Response 200 (application/json)

    {
        "id": 3,
        "name": "cervejinha gelada"
    }

PostsBlogs [/post]

Listar /post [GET]

Listar todos os posts salvos no banco de dados /post

Request (application/json)

Headers (Token fictício)

  {           
      "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
  }

Response 200 (application/json)

   [
        {
            "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": "lewishamilton@gmail.com",
                "image": "https://upload.wikimedia.org"
            },
            "categories": [
                {
                    "id": 1,
                    "name": "Inovação"
                }
            ]
        },
        {
            "id": 2,
            "title": "Vamos que vamos",
            "content": "Foguete não tem ré",
            "userId": 1,
            "published": "2011-08-01T19:58:00.000Z",
            "updated": "2011-08-01T19:58:51.000Z",
            "user": {
                "id": 1,
                "displayName": "Lewis Hamilton",
                "email": "lewishamilton@gmail.com",
                "image": "https://upload.wikimedia.org"
            },
            "categories": [
                {
                    "id": 2,
                    "name": "Escola"
                }
            ]
        }
    ]

Listar por id /post/id [GET]

Listar um post por um id específico /post/1

Headers (Token fictício)

      {           
          "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
      }

Response 200 (application/json)

    {
          "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": "lewishamilton@gmail.com",
              "image": "https://upload.wikimedia.org"
          },
          "categories": [
              {
                  "id": 1,
                  "name": "Inovação"
              }
          ]
      }

Quando o post não existe /post/5

  + Headers (Token fictício)

        {           
            "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
        }

Response 404 (application/json)

[
  {
    "message": "Post does not exist"
  }
]

Listar por query [GET]

Utilizando uma query na url /post/search/?q=vamos

+ Headers (Token fictício)

    {           
        "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
    }

+ Response 200 (application/json)

[
        {
            "id": 2,
            "title": "Vamos que vamos",
            "content": "Foguete não tem ré",
            "userId": 1,
            "published": "2011-08-01T19:58:00.000Z",
            "updated": "2011-08-01T19:58:51.000Z",
            "user": {
                "id": 1,
                "displayName": "Lewis Hamilton",
                "email": "lewishamilton@gmail.com",
                "image": "https://upload.wikimedia.org/"
            },
            "categories": [
                {
                    "id": 2,
                    "name": "Escola"
                }
            ]
        }
]

Quando passamos query vazia, retorna todos os dados do banco /post/search/?q=

+ Headers (Token fictício)

    {           
        "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
    }

+ Response 200 (application/json)

    [
            {
                "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": "lewishamilton@gmail.com",
                    "image": "https://upload.wikimedia.org
                },
                "categories": [
                    {
                        "id": 1,
                        "name": "Inovação"
                    }
                ]
            },
            {
                "id": 2,
                "title": "Vamos que vamos",
                "content": "Foguete não tem ré",
                "userId": 1,
                "published": "2011-08-01T19:58:00.000Z",
                "updated": "2011-08-01T19:58:51.000Z",
                "user": {
                    "id": 1,
                    "displayName": "Lewis Hamilton",
                    "email": "lewishamilton@gmail.com",
                    "image": "https://upload.wikimedia.org
                },
                "categories": [
                    {
                        "id": 2,
                        "name": "Escola"
                    }
                ]
            }
    ]

Quando não passa query /post/search

+ Headers (Token fictício)

    {           
        "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
    }
 + Response 200 (application/json)

    [

    ]

Criar /post [POST]

Request (application/json)
- Headers (Token fictício)
```
  {           
      "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
  }
```
- body { "title": "pagode e felicidade", "content": "tudo muto bom", "categoryIds": [1, 2] }

Response 201 (application/json)

    {
        "id": 3,
        "userId": 4,
        "title": "pagode e felicidade",
        "content": "tudo muto bom"
    }

Quando a categoria não existe no banco de dados.

Request (application/json)

Headers (Token fictício)

    {           
        "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
    }

body

{
    "title": "pagode e felicidade",
    "content": "tudo muto bom",
    "categoryIds": [1, 9]
}

Response 400 (application/json)

    {
        " "message": "\"categoryIds\" not found"
    }

Quando as validações falham

Quando "title" é passado em branco ou não é passado.

Request (application/json)

Headers (Token fictício)

      {           
          "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
      }

body

{
    "content": "tudo muto bom",
    "categoryIds": [1, 9]
}

Response 400 (application/json)

    {
        "message": "\"title\" is required"
    }

Quando "content" é passado em branco ou não é passado.

Request (application/json)

Headers (Token fictício)

      {           
          "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
      }

body

{
    "title": "pagode e felicidade",
    "categoryIds": [1, 9]
}

Response 400 (application/json)

    {
        "message": "\"content\" is required"
    }

Quando "categoryIds" não é passado.

Request (application/json)

Headers (Token fictício)

      {           
          "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
      }

body

{   
    "content": "tudo muto bom",
    "title": "pagode e felicidade",
}

Response 400 (application/json)

    {
        "message": "\"categoryIds\" is required"
    }

Atualizar /post/id [PUT]

Atualizar um post /post/3

Request (application/json)

Headers (Token fictício)

  {           
      "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
  }

body

  {
    "title": "Vou embora",
    "content": "Amanhã eu volto"
  }

Response 200 (application/json)

    {
        "id": 3,
        "title": "Vou Embora",
        "content": "Amanhã eu volto",
        "userId": 4,
        "published": "2022-03-14T20:43:45.000Z",
        "updated": "2022-03-14T20:43:45.000Z",
        "categories": [
            {
                "id": 1,
                "name": "Inovação"
            },
            {
                "id": 2,
                "name": "Escola"
            }
        ]
    }

Quando você não foi o criador do post /post/1

Request (application/json)

Headers (Token fictício)

  {           
      "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
  }

body

  {
    "title": "Vou embora",
    "content": "Amanhã eu volto"
  }

Response 200 (application/json)
```
{
    "message": "Unauthorized user"
}
```

Quando o id do post não existe no banco de dados.

Atualizar um post /post/9

Request (application/json)

Headers (Token fictício)

  {           
      "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
  }

body

  {
    "title": "Vou embora",
    "content": "Amanhã eu volto"
  }

Response 404 (application/json)

{ "message": "Post does not exist " }

Deletar /post/id [DELETE]

Quando deleta um post post/1

Request (application/json)

Headers (Token fictício)

  {           
      "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
  }

Response 204 (application/json)

Quando o id não exste um post post/99

Request (application/json)

Headers (Token fictício)

  {           
      "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
  }

Response 404 (application/json)

  { 
        message: 'Post does not exist' 
  }

Quando o usuário atual não é o criador do post post/1

Request (application/json)

Headers (Token fictício)

  {           
      "Authorization": "MywiZXhwIjoxNjQ3NDQwNjIzfQ.osA0qOI5CgJFkMqubqT7Vu7AAl5lx"
  }

Response 401 (application/json)

  { 
        message: 'Unauthorized user' 
  }

coutinhomarco / blogs-api

🚧 ApiBlogs 🚀 Finalizado 🚧

Sobre

Instalar o projeto em sua máquina

Pré-requisitos

Rodando a aplicação .

Métodos

Respostas

EndPoints

Token

Validações

Usuários [/user]

Criar /user [POST]

Quando as validações falham

Listar /user [GET]

Listar por id /user/id [GET]

Quando o usuário não existe /user/5

Deletar /post/me [DELETE]

Login [/login]

Login /login [POST]

Listar /categories [GET]

Criar /categories [POST]

PostsBlogs [/post]

Listar /post [GET]

Listar por id /post/id [GET]

Quando o post não existe /post/5

Listar por query [GET]

Criar /post [POST]

Quando as validações falham

Atualizar /post/id [PUT]

Quando você não foi o criador do post /post/1

Quando o id do post não existe no banco de dados.

Deletar /post/id [DELETE]

About

Languages