This repository has been archived by the owner on Apr 24, 2024. It is now read-only.
Getting Started
Johannes Rudolph edited this page Aug 14, 2013
·
10 revisions
This documentation is for release 0.9.0 (from 03/2012), which is built against Scala 2.9.1 and Akka 1.3.1 (see Requirements for more information). Most likely, this is not the place you want to look for information. Please turn to the main spray site at http://spray.io for more information about other available versions.
. . .
The easiest way to get started is to use the Template Project as a starting point. It contains a minimal ready-to-run spray application that you can use as a basis for your own projects.
Even if you don't want to base your application on the Template Project you should check it out for info on how to set up the basic wiring. Here is the run down of the main points to get right:
- Fetch the spray-server artifact (available from the https://oss.sonatype.org/content/groups/scala-tools maven repositories)
- Create an
akka.conf
file on the classpath and configure the "boot" property with the FQN of your boot class - If you'd like to run spray on top of a servlet container:
Make sure your
web.xml
looks similar to the one from the template project and enable the correctConnectorServlet
for your setup. - If you'd like to run spray on top of spray-can:
Check out the
spray-can
branch of the template project or turn to the spray-example-spray-can.
- Home
- Requirements
- ... Getting Started
- ... Key Concepts
- ...... Request Lifecycle
- ...... Routes
- ...... Directives
- ...... Composing Directives
- ...... Rejections
- ...... Marshalling and Unmarshalling
- ... Predefined Directives
- ...... Method Filters
- ...... Path Filters
- ...... Parameter Filters
- ...... Form-Field Filters
- ...... Marshalling/Unmarshalling
- ...... Caching
- ...... Detach
- ...... Encoding/Decoding
- ...... Authentication/Authorization
- ...... File and Resource Directives
- ...... Misc Directives
- ... Advanced Topics
- ...... Case Class Extraction
- ...... Custom Directives
- ...... Custom Media Types
- ...... Custom Error Responses
- ... Configuration
- ... Testing
- ... Example Projects
- spray-client
- Patch Policy
- Credits
- Sponsors