wai-routing: Declarative routing for WAI.

The wai-routing package

[ Tags: benchmark, library, mpl, web ] [ Propose Tags ]

Enables the declaration of "routes" which handle requests to a specific URL.

The set of possible handlers can be restricted by "predicates", which operate on WAI requests and have to be true or else the handler will not be called.

For details have a look at the haddock documentation of Network.Wai.Routing.Tutorial or the examples folder in the source distribution.

This library is a port of snap-predicates which provides similar functionality for the snap-framework.

The routing tree construction is implemented using wai-route.

[Skip to Readme]

Properties

Versions 0.1, 0.2, 0.3, 0.3.1, 0.4, 0.4.1, 0.5, 0.5.1, 0.5.2, 0.5.3, 0.6, 0.7, 0.8, 0.9, 0.9.1, 0.10, 0.10.1, 0.10.2, 0.11, 0.11.1, 0.12, 0.12.1, 0.12.2, 0.12.3, 0.13.0
Dependencies attoparsec (>=0.10 && <0.12), base (==4.*), bytestring (>=0.9 && <0.11), bytestring-from (==0.1.*), case-insensitive (==1.1.*), cookie (==0.4.*), http-types (==0.8.*), transformers (==0.3.*), wai (==2.0.*), wai-route (==0.1.*) [details]
License OtherLicense
Copyright (c) 2014 Toralf Wittner
Author Toralf Wittner
Maintainer Toralf Wittner <tw@dtex.org>
Category Web
Source repository head: git clone git://github.com/twittner/wai-routing.git
Uploaded Thu Feb 20 23:02:17 UTC 2014 by ToralfWittner
Distributions LTSHaskell:0.13.0, NixOS:0.13.0, Stackage:0.13.0
Downloads 4329 total (34 in the last 30 days)
Rating 0.0 (0 ratings) [clear rating]
  • λ
  • λ
  • λ
Status Docs available [build log]
Successful builds reported [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for wai-routing-0.3

[back to package description]

wai-routing enables the declaration of "routes" which handle requests to a specific URL.

The set of possible handlers can be restricted by "predicates", which operate on WAI requests and have to be true or else the handler will not be called.

For details have a look at the haddock documentation of Network.Wai.Routing.Tutorial or the examples folder in the source distribution.

This library is a port of snap-predicates which provides similar functionality for the snap framework.

The routing tree construction is implemented using wai-route.

Here is a simple usage example.

import Data.ByteString (ByteString)
import Data.Text (Text)
import Network.Wai
import Network.Wai.Routing
import Network.Wai.Handler.Warp

main :: IO ()
main = run 8080 (route (prepare start))

start :: Monad m => Routes a m ()
start = do
    get "/user/:name" fetchUser $
        capture "name"

    get "/user/find" findUser $
        query "byName" :||: query "byId"

    delete "/user/:name" rmUser $
        capture "name" :&: opt (cookie "foo")

fetchUser :: Monad m => Text -> m Response
fetchUser name = ...

findUser :: Monad m => Either ByteString Word64 -> m Response
findUser (Left  name)  = ...
findUser (Right ident) = ...

rmUser :: Monad m => Text ::: Maybe Int -> m Response
rmUser (name ::: foo)  = ...