Architecture example using Rest-Assured for api tests

Para acessar a versão em Português do Brasil, basta clicar aqui! 🇧🇷

This project was created for example of structure for api testing using Java and Rest-Assured.

Technologies and tools used:

• Java
• Rest-Assured
• Gson
• Lombok
• Junit 5
• Allure
• Java faker

File structure:

📦src
┣ 📂main
┃ ┣ 📂java
┃ ┗ 📂resources
┗ 📂test
┃ ┣ 📂java
┃ ┃ ┗ 📂io
┃ ┃ ┃ ┗ 📂github
┃ ┃ ┃ ┃ ┗ 📂maximilianoalves
┃ ┃ ┃ ┃ ┃ ┣ 📂payloads
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂model
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂login
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜LoginModel.java
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂produtos
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜ProdutosModel.java
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂usuarios
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜UsuariosModel.java
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜LoginPayload.java
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜ProdutosPayload.java
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜UsuariosPayload.java
┃ ┃ ┃ ┃ ┃ ┣ 📂runners
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜SchemasTestsRunner.java
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜TodosTestsRunner.java
┃ ┃ ┃ ┃ ┃ ┣ 📂tests
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂base
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂requests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜BaseRequest.java
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂tests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜BaseTest.java
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂carrinhos
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂requests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜CarrinhosRequest.java
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂tests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜CarrinhosTest.java
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂login
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂requests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜LoginRequest.java
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂tests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜LoginTest.java
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂produtos
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂requests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜ProdutosRequest.java
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂tests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜ListarProdutosTest.java
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂usuarios
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂requests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜UsuariosRequest.java
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂tests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜CadastrarUsuariosTest.java
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜ExcluirUsuariosTest.java
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜ListarUsuariosTest.java
┃ ┃ ┃ ┃ ┃ ┗ 📂utils
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜Utils.java
┃ ┗ 📂resources
┃ ┃ ┣ 📂schemas
┃ ┃ ┃ ┣ 📂produtos
┃ ┃ ┃ ┃ ┣ 📜produto.json
┃ ┃ ┃ ┃ ┗ 📜produtos.json
┃ ┃ ┃ ┣ 📂usuarios
┃ ┃ ┃ ┃ ┣ 📜usuario.json
┃ ┃ ┃ ┃ ┗ 📜usuarios.json

Execution Examples:

    mvn test -Dgroups=todos

Execution report

• Job:

  • https://github.com/maximilianoalves/restassured-arch-template/actions/workflows/java-test-with-allure.yml

• Report:

  • https://maximilianoalves.github.io/restassured-arch-template/

Doubts or improvements !? contact me: