9bc01ae265
The idea is to filter the sources, replacing @<var>@ occurrences with the mapping for <var> (which is currently hard-coded). @@ -> @. In order to make this work, I had to move the doc sources one directory down (into akka-docs/rst) so that the filtered result could be in a sibling directory so that relative links (to _sphinx plugins or real code) would continue to work. While I was at it I also changed it so that WARNINGs and ERRORs are not swallowed into the debug dump anymore but printed at [warn] level (minimum). One piece of fallout is that the (online) html build is now run after the normal one, not in parallel.
38 lines
1.3 KiB
ReStructuredText
38 lines
1.3 KiB
ReStructuredText
.. _http-module:
|
|
|
|
HTTP
|
|
####
|
|
|
|
Play2 Mini
|
|
==========
|
|
|
|
The Akka team recommends the `Play2 Mini <https://github.com/typesafehub/play2-mini>`_ framework when building RESTful
|
|
service applications that integrates with Akka. It provides a REST API on top of `Play2 <https://github.com/playframework/Play20/>`_.
|
|
|
|
Getting started
|
|
---------------
|
|
|
|
Easiest way to get started with `Play2 Mini <https://github.com/typesafehub/play2-mini>`_ is to use the
|
|
G8 project templates, as described in the `Play2 Mini Documentation <https://github.com/typesafehub/play2-mini>`_.
|
|
|
|
If you already have an Akka project and want to add Play2 Mini, you must first add the following to
|
|
your ``libraryDependencies``::
|
|
|
|
libraryDependencies += "com.typesafe" %% "play-mini" % "<version-number>"
|
|
|
|
In case you need to start Play2 Mini programatically you can use::
|
|
|
|
play.core.server.NettyServer.main(Array())
|
|
|
|
|
|
Akka Mist
|
|
=========
|
|
|
|
If you are using Akka Mist (Akka's old HTTP/REST module) with Akka 1.x and wish to upgrade to 2.x
|
|
there is now a port of Akka Mist to Akka 2.x. You can find it `here <https://github.com/thenewmotion/akka-http>`_.
|
|
|
|
Other Alternatives
|
|
==================
|
|
|
|
There are a bunch of other alternatives for using Akka with HTTP/REST. You can find some of them
|
|
among the `Community Projects <http://akka.io/community>`_.
|