This application is a RESTful JSON API that could back a simple note taking application.

The project is written in Java and uses the Spark micro framework for routing, Google gson for serializing and de-serializing JSON, and Sql2o for connecting with the MySql database.

This project relies on Docker to host the environment the application will run in.

Please install Docker on your local environment.

After Docker is installed, run the following commands from the root of the project directory.

Build/Start the MySql Container. Ensure that port 3306 is available and don't forget to replace the <absolutePathToProject>. This will also create and seed the database.

docker run -p 3306:3306 --name felttrip_mysql -v <absolutePathToProject>/lb-backend/sql:/docker-entrypoint-initdb.d -e MYSQL_ROOT_PASSWORD=pass -e MYSQL_DATABASE=lb_backend -d mysql:5.7

Build the image of the project. This will create an image that has the Spark application compiled with all dependencies.

docker build -t felttrip/lb-backend .

Verify that MySql has started successfully in the felttrip_mysql container.

docker logs felttrip_mysql

Start a container with the applications image.

docker run -p 80:4567 --name felttrip_lb_backend --link felttrip_mysql:my_mysql -d felttrip/lb-backend

GET /api/notes
Returns: A list of my notes

Example Curl

curl -i -H "Content-Type: application/json" -X GET http://localhost/api/notes

GET /api/notes/1
Returns: A single note with id 1

Example Curl

curl -i -H "Content-Type: application/json" -X GET http://localhost/api/notes/1

GET /api/notes?query=milk
Returns: A note with the string "milk" in its body

Example Curl

curl -i -H "Content-Type: application/json" -X GET http://localhost/api/notes?query=milk

POST /api/notes
BODY a note
Returns: a saved note...

Example Curl

curl -i -H "Content-Type: application/json" -X POST -d '{"body" : "Pick up milk!"}' http://localhost/api/notes