I have created this project during my research on scala/spray/akka/slick/mysql REST service.
It may be used to learn a bit on how to use those technologies to create REST service. It's just a prove of concept though and it's not production ready. It definitely can be used as a good start.
Additionally websocket (https://github.com/wandoulabs/spray-websocket) was added to project. All events in the REST system like create/update/delete of resource are publishing information to all connected clients via websocket.
The database underneath is mysql, but it can be easily switch to any other which is supported by slick.
- Mysql server - up and running
- Java with maven is installed
- That's it
- Set up user and database on mysql server
- Edit db.conf in resources to configure db connection
- take a look at com.vixxx123.scalasprayslickexample.example.api.person.PersonApi as example
class CompanyApi(val actorContext: ActorContext, companyDao: CompanyDao, override val authorization: Authorization)
extends BaseResourceApi with Logging {
/**
* Handler val names must be unique in the system - all
*/
private val companyCreateHandler = actorContext.actorOf(RoundRobinPool(2).props(CreateActor.props(companyDao)), CreateActor.Name)
private val companyPutHandler = actorContext.actorOf(RoundRobinPool(5).props(UpdateActor.props(companyDao)), UpdateActor.Name)
private val companyGetHandler = actorContext.actorOf(RoundRobinPool(20).props(GetActor.props(companyDao)), GetActor.Name)
private val companyDeleteHandler = actorContext.actorOf(RoundRobinPool(2).props(DeleteActor.props(companyDao)), DeleteActor.Name)
override val logTag: String = getClass.getName
override def init() = {
companyDao.initTable()
super.init()
}
override def authorisedResource = true
override def route(implicit userAuth: RestApiUser) = {
pathPrefix(ResourceName) {
pathEnd {
get {
ctx => companyGetHandler ! GetMessage(ctx, None)
} ~
post {
entity(as[Company]) {
company =>
ctx => companyCreateHandler ! CreateMessage(ctx, company)
}
}
} ~
pathPrefix(IntNumber) {
entityId => {
pathEnd {
get {
ctx => companyGetHandler ! GetMessage(ctx, Some(entityId))
} ~ put {
entity(as[Company]) { entity =>
ctx => companyPutHandler ! PutMessage(ctx, entity.copy(id = Some(entityId)))
}
} ~ delete {
ctx => companyDeleteHandler ! DeleteMessage(ctx, entityId)
} ~ patch {
entity(as[List[JsonNotation]]) { patch =>
ctx => companyPutHandler ! PatchMessage(ctx, patch, entityId)
}
}
}
}
}
}
}
}
class CompanyApiBuilder extends Api{
override def create(actorContext: ActorContext, authorization: Authorization): BaseResourceApi = {
new CompanyApi(actorContext, new CompanyDao, authorization)
}
}
- create new routing class - which inherits from BaseResourceApi
- method init should be used to initialize resource. It is run once on server start up. I use it to create db tables if they don't exists yet
- method route - should define REST route for new API
- method authorisedResource - states if authorization should be turn on/off for this resource
- create new object/class which inherits from
- create method should return new routing class (created in previous step)
- in RestExampleApp object add your Api class to list.
object RestExampleApp extends App {
new Rest(ActorSystem("on-spray-can"), List(PersonApi, CompanyApi), List(new ConsoleLogger))
}- that's it - you are good to go
PersonApi class is just an example you don't have to implement handling incoming request same way, but I think it's quite good design. It give a possibility to configure number of workers per request type etc. Of course it is possible to handle request inline and no additional actors are needed.
- Each type of resource and method can have different numbers of actors - easy to optimise performance
- Fully based on Akka
- Uses Slick for persistence - easy to switch between databases (at least it should be easy :) )
- Push messaging via websocket to all open connections or to specific user
- Authorization with simplest(client_credentials) OAuth 2 implementation
- mvn clean install
- mvn scala:run -DmainClass=com.vixxx123.scalasprayslickexample.RestExampleApp
- configuration of logging levels
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent