Data.IterIO.Http.Support.RestController

This module defines the RestController class

Documentation

class Monad m => RestController t b m a where

The class RestController allows a set of actions to be routed using RESTful HTTP verbs.

Methods

restIndex :: a -> Action t b m ()

GET /

restShow :: a -> ByteString -> Action t b m ()

GET /:id

id is passed in as the second parameter.

restNew :: a -> Action t b m ()

GET /new

restCreate :: a -> Action t b m ()

POST /

restEdit :: a -> ByteString -> Action t b m ()

GET /:id/edit

id is passed in as the second parameter.

restUpdate :: a -> ByteString -> Action t b m ()

PUT /:id

id is passed in as the second parameter.

Since PUT is not supported by many browsers, this action also responds to requests containing the HTTP header X-HTTP-Method-Override: PUT regardless of the actual HTTP method (GET or POST)

restDestroy :: a -> ByteString -> Action t b m ()

DELETE /:id

id is passed in as the second parameter.

Since DELETE is not supported by many browsers, this action also responds to requests containing the HTTP header X-HTTP-Method-Override: DELETE regardless of the actual HTTP method (GET or POST)

routeRestController :: RestController t b m a => String -> a -> ActionRoute b m t

Routes URLs under the given String to actions in a RestController. For example

    routeRestController posts myRestController

will map the follwoing URLs:

• GET /posts => myRestController#restIndex
• POST /posts => myRestController#restCreate
• GET /posts/:id => myRestController#restShow
• GET /posts/:id/edit => myRestController#restEdit
• GET /posts/:id/new => myRestController#restNew
• DELETE /posts/:id => myRestController#restDestroy
• PUT /posts/:id => myRestController#restUpdate