onidino / crudcleanarch_spark Goto Github PK

A simple Java Gradle REST-API with SPARK using Clean Architecture to assure the implementation of the SOLID principles and with mySQL database with DOCKER.

• SPARK: https://sparkjava.com/

• SOLID PRINCIPLES: https://www.baeldung.com/solid-principles

• CLEAN ARCHITECTURE: https://medium.com/slalom-build/clean-architecture-with-java-11-f78bba431041

• MYSQL DATABASE - sql2o library: https://www.baeldung.com/java-sql2o

The project has CRUD operations implemented in 4 entrypoints for POST, GET, PUT, DELETE. This allows to create and modify records with a numeric "id" (autoincremental) and "record_data" as text information, wich are saved in a mySQL database.

• ENDPOINTS:

  curl --request POST
  --url http://localhost:8080/clean/spark/create
  --header 'Content-Type: application/json'
  --data '{ "record_data" : null }'

  curl --request GET
  --url http://localhost:8080/clean/spark/read/ID
  --header 'Content-Type: application/json'

  curl --request PUT
  --url http://localhost:8080/clean/spark/update/ID
  --header 'Content-Type: application/json'
  --data '{ "record_data" : null }'

  curl --request DELETE
  --url http://localhost:8080/clean/spark/delete/ID

To test the api locally you should create a mySQL database and create a simple "record" table with the structure similar to the one in the script found in:

• database/scripts/create_record_table

The specific parameters for the database configuration can be found at:

• application/src/main/resources/database.properties

TEST EXAMPLES

Jupiter (Junit) was used for making the tests, and HSQL for database tests.

HSQL: https://www.baeldung.com/java-in-memory-databases