Blog do Éde - Backend

Esse repositório é uma implementação de API REST utilizando o MySQL e o Spring Boot para o projeto de Blog Pessoal do Bootcamp Generation.

A aplicação está rodando no Heroku neste link.

Um frontend pra consumir essa api está sendo desenvolvido e você pode acompanhar neste repositório.

Especificações

• Spring Boot 2.6.2
• OpenJDK 17
• Maven 3.8.1
• MySQL Server 8.0.27

Modelagem

A modelagem do banco de dados foi feita como parte dos exercícios de MySQL do Bootcamp e está documentada neste repositório, mas basicamente possui três tabelas seguindo um modelo simples de rede social. As tabelas são tb_tema, tb_postagem e tb_usuario, conforme o diagrama abaixo:

Arquitetura

Esse projeto segue o padrão MVC e está distribuído em pacotes conforme a imagem abaixo:

• Configuration: Contém as classes de configuração do Swagger e do ModelMapper.

• Controller: Contém as classes referentes aos endpoints das três entidades. Os endopoints em UsuarioController são pra cadastro e login de usuários. Os de TemaController e PostagemController só são acessíveis com autenticação.

• Domain: Contém as classes model e seus respectivos repositórios.

• DTO: É a camada de transferência de dados.

• Security: Camada de configurações do Spring Security pra trabalhar com a parte de autenticação e autorização de usuários.

• Service: Camada de serviços. Na UsuarioService estão os métodos pra cadastro e login de usuário. Esses métodos fazem a parte de criptografia da senha, validação de login e token de sessão.

Rodando

1. Abrir o git e clonar este repositório pra sua máquina:

   git clone https://github.com/oieusouoede/generation-blogpessoal

2. Importar o projeto no Eclipse ou IntelliJ (checar compatibilidade no caso do IntelliJ)

3. A api está configurada pra rodar com o profile de produção. Pra rodar localmente é necessário especificar o perfil 'dev' dentro do application.properties.

4. Como o projeto é pra fins de estudo, o arquivo de configuração do banco de dados está com usuário e senha 'root'. Eventualmente eu vou trocar, mas tenha em mente que sua configuração pode ser diferente.

5. Rodar a aplicação a partir da classe principal.

Endpoints

Se der tudo certo a api vai estar disponível na url https:localhost:8080 e os endpoints vão poder ser acessados pelo Postman, Rested ou ferramenta similar.

Em api/user/register e api/user/login é possível enviar uma POST request pra, respectivamente, o cadastro e autenticação de usuário.

O restante dos endpoints só são acessíveis com autenticação. São eles:

• Usuários

  /api/users/all : Recebe requisição GET e retorna todos os usuários.

  /api/users/{id} : Recebe requisições GET e DELETE passando um id como parâmetro pra fazer busca por id ou deletar um usuário com base no id.

  /api/users/update : Recebe requisições PUT passando um JSON com um objeto usuário para alteração.

• Postagens

  /posts : Recebe requisições POST, pra inserção e PUT pra atualização de postagens.

  /posts/all : Recebe requisição GET e retorna todas as postagens.

  /posts/{id} : Recebe requisições GET e DELETE passando um id como parâmetro pra fazer busca por id ou deletar uma postagem com base no id.

  /posts/title/{title} : Recebe requisições GET passando uma string "titulo" como parâmetro, reliza busca de postagens com base no título.

• Temas

  /subject : Recebe requisições POST, pra inserção e PUT pra atualização de tema.

  /subject/all : Recebe requisição GET e retorna todos os temas.

  /subject/{id} : Recebe requisições GET e DELETE passando um id como parâmetro pra fazer busca por id ou deletar um tema com base no id.

  /subject/desc/{desc} : Recebe requisições GET passando uma string "desc" como parâmetro, reliza busca de temas com base na descrição.

Por enquanto é só

Éde.