Hails.Web.REST

REST is a DSL for creating routes using RESTful HTTP verbs. See http://en.wikipedia.org/wiki/Representational_state_transfer

For example, an app handling users may define a REST controller as:

module SimpleREST (server) where
 
import           Data.String
import           Data.Maybe
import           Control.Monad

import           LIO
import           Hails.HttpServer.Types
import           Hails.Web
import qualified Hails.Web.REST as REST

server :: Application
server = mkRouter $ routeName "users" $ do
  REST.index $ do
    req <- request >>= unlabel
    return $ okHtml $ fromString $
      "Welcome Home " ++ (show $ serverName req)
  REST.show $ do
    userId <- fromMaybe "" ``liftM`` queryParam "id"
    return $ ok "text/json" $ fromString $
      "{\"myid\": " ++ (show userId) ++ "}"
  ...

With hails, you can directly run this:

hails --app=SimpleREST

And, with curl, you can now checkout your page:

$ curl localhost:8080/users
Welcome Home "localhost"

$ curl localhost:8080/users/123
{"myid": "123"}

$ ...

Documentation

type RESTController = RESTControllerM ()

Monad used to encode a REST controller incrementally. The return type is not used, hence always '()'.

index :: Routeable r => r -> RESTController

GET /

show :: Routeable r => r -> RESTController

GET /:id

create :: Routeable r => r -> RESTController

POST /

update :: Routeable r => r -> RESTController

PUT /:id

delete :: Routeable r => r -> RESTController

DELETE /:id

edit :: Routeable r => r -> RESTController

GET /:id/edit

new :: Routeable r => r -> RESTController

GET /new