MarcosLudgerio/api-automation-test

Api repository used in the VIRTUS company api testing course

📚 API Restful para treinamento de testes de APIs

Descrição • O que a API faz? • Rotas • Modelos • Tecnologias • Pré requisitos • Executar o projeto • Autor

📝 Descrição

Este projeto é uma API restful desenvolvida utilizando o framework Spring Boot, na linguagem de programação java.
O intuito de sua produção é para que fique disponível para que sejam efetuados testes de API Restful.
O link de acesso ao Heroku pode ser acessado aqui (temporariamente indisponível para manutenção)
A documentação SWAGGER da aplicação está disponível nesse link (temporariamente indisponível para manutenção)

⚙️ O que a API faz?

A API Restful da suporte a aplicações de postagens.
Consiste em dois módulos: usuário e publicações (posters), onde um usuário cria pode criar uma ou várias publicações
Para cadastrar um usuário é necessário ter: nome, email e senha como campos obrigatórios e, caso deseje, biografia, site e url da imagem de perfil
Para cadastrar uma publicação é necessário ter: titulo e texto

📑 Exemplos

JSON para criação de usuário:

{
   "name": "Raimundo",
   "lastname": "Lugério",
   "email": "raimundo@dcx.ufpb.br",
   "password": "umasenhadificil",
   "bio": "a litle nice guy",
   "site": "http://github.com/MarosLudgerio",
   "urlImage": "http://github.com/MarosLudgerio.png"
}

JSON para criação de poster:

{
   "titulo": "poster 1",
   "texto": "texto"
}

🚏 Rotas

Login

• POST /auth/login

Usuário

• POST /api/users
• GET /api/users
• GET /api/users/details
• PUT /api/users

Publicações

• GET /api/posters
• GET /api/posters/id
• POST /api/posters
• PUT /api/posters/id
• DELETE /api/posters/id

✨ Tecnologias

• Java
• Spring Boot
• Thymeleaf
• PostgreSQL
• Project Lombok
• Spring Data JPA
• Swagger
• Json Web Token
• Hibernate
• Model Mapper

📑 Pré requisitos

Para executar o projeto localmente, é necessário ter:

1. PostgreSQL instalado
2. Banco criado (para perfil Dev)
3. Java 11
4. Arquivo application.properties selecione o perfil que deseja ativar para API

   1. spring.profiles.active=

   2. Opções de perfis: dev e test.

      1. O perfil dev precisa ser configurado corretamente no arquivo application-dev.properties
      2. O perfil test a aplicação irá executar em um banco em memória, todos os dados serão excluídos quando a aplicação parar a execução

▶️ Executando o projeto

Para acessar a API Restful remotamente, basta clicar aqui

NOTE: Normalmente, a aplicação demora uns minutos para inciar

Para executar localmente, siga os passos:

$ git clone https://github.com/MarcosLudgerio/api-automation-test.git
$ cd api-automation-test
$ ./mvnw install
$ ./mvnw spring-boot:run

👩‍💻 Autor

Marcos Ludgério