Tommyzhou1 / scala-simple-rest-server

Simple REST server made with akka http and quill

Simple server with simple REST API

Requirements

• Scala
• Sbt
• Docker
• Docker-compose

Run

The server will run on localhost:8080. Steps to run the project:

$ docker-compose up -d
$ sbt run

Database connection details are found in src/main/resources/application.conf. When using this example they should match the values in docker-compose.yml.

Use curl to access the 'api'. It consist of four simple actions:

GET /persons -- get all persons in the database

GET /persons/id -- get single person by id

POST /persons -- add new person

DELETE /persons/id -- delete person by id

---

This project uses Akka Http for the server and Quill for database access.

Main.scala contains the server and the routes for the endpoints, while PersonDAO.scala contains all the database interaction stuff.

Full examples:

Get all persons

$ curl -w "\n" -X GET localhost:8080/persons
{"persons":[{"id":1,"name":"niels","age":28},{"id":2,"name":"laura","age":29},{"id":3,"name":"allan","age":68},{"id":4,"name":"merete","age":67},{"id":5,"name":"asser","age":34},{"id":6,"name":"sofie","age":31}]}

Get a particular person (by id):

$ curl -w "\n" -X GET localhost:8080/persons/1
{"id":1,"name":"niels","age":28}

Add a person (providing name and age):

$ curl -w "\n" -X POST -H "Content-Type: application/json" -d '{"name": "mads", "age": 35}' localhost:8080/persons
{"id":19,"name":"mads","age":35}

$ curl -w "\n" -X GET localhost:8080/persons
{"persons":[{"id":1,"name":"niels","age":28},{"id":2,"name":"laura","age":29},{"id":3,"name":"allan","age":68},{"id":4,"name":"merete","age":67},{"id":5,"name":"asser","age":34},{"id":6,"name":"sofie","age":31},{"id":19,"name":"mads","age":35}]

Delete a person (by id):

$ curl -w "\n" -X DELETE localhost:8080/persons/6
Deleted person with id 19

$ curl -w "\n" -X GET localhost:8080/persons/6
No such person!

$ curl -w "\n" -X GET localhost:8080/persons
{"persons":[{"id":1,"name":"niels","age":28},{"id":2,"name":"laura","age":29},{"id":3,"name":"allan","age":68},{"id":4,"name":"merete","age":67},{"id":5,"name":"asser","age":34},{"id":6,"name":"sofie","age":31}]}

Thoughts on DELETE

When I switched from Slick to Quill, I was no longer able to differentiate between a "successful" delete (where the resource existed) and an "unsuccessful" one (where the resource did not exist).

This post on stackoverflow suggest that it's fine to return 200 or 204 when requesting to delete a resource that does not exist: https://stackoverflow.com/questions/6439416/deleting-a-resource-using-http-delete