This project demonstrates the Akka HTTP library and Scala to write a simple REST (micro)service. The project shows the following tasks that are typical for most Akka HTTP-based projects:
- starting standalone HTTP server,
- handling file-based configuration,
- logging,
- routing,
- deconstructing requests,
- unmarshalling JSON entities to Scala's case classes,
- marshaling Scala's case classes to JSON responses,
- error handling,
- issuing requests to external services,
- testing with mocking of external services.
The service in the template provides two REST endpoints - one which gives GeoIP info for given IP and another for calculating geographical distance between given pair of IPs. The project uses the service ip-api which offers JSON IP and GeoIP REST API for free for non-commercial use.
Start services with sbt:
$ sbt
> ~re-start
With the service up, you can start sending HTTP requests:
$ curl http://localhost:9000/ip/8.8.8.8
{
"city": "Mountain View",
"query": "8.8.8.8",
"country": "United States",
"lon": -122.0881,
"lat": 37.3845
}
$ curl -X POST -H 'Content-Type: application/json' http://localhost:9000/ip -d '{"ip1": "8.8.8.8", "ip2": "93.184.216.34"}'
{
"distance": 4347.624347494718,
"ip1Info": {
"city": "Mountain View",
"query": "8.8.8.8",
"country": "United States",
"lon": -122.0881,
"lat": 37.3845
},
"ip2Info": {
"city": "Norwell",
"query": "93.184.216.34",
"country": "United States",
"lon": -70.8228,
"lat": 42.1508
}
}
Execute tests using test command:
$ sbt
> test
If you have any questions regarding this project contact:
Łukasz Sowa lukasz@theiterators.com from Iterators.
For licensing info see LICENSE file in project's root directory.