The wai package

[Tags:library, mit, test]

API docs and the README are available at http://www.stackage.org/package/wai.


[Skip to Readme]

Properties

Versions 0.0.0, 0.0.1, 0.1.0, 0.2.0, 0.2.1, 0.2.2, 0.2.2.1, 0.3.0, 0.3.1, 0.3.2, 0.4.0, 0.4.1, 0.4.2, 0.4.3, 1.0.0, 1.1.0, 1.1.0.1, 1.2.0, 1.2.0.1, 1.2.0.2, 1.2.0.3, 1.3.0, 1.3.0.1, 1.3.0.2, 1.3.0.3, 1.4.0, 1.4.0.1, 1.4.0.2, 1.4.1, 2.0.0, 2.1.0, 2.1.0.1, 2.1.0.2, 2.1.0.3, 3.0.0, 3.0.0.1, 3.0.0.2, 3.0.1, 3.0.1.1, 3.0.2, 3.0.2.1, 3.0.2.2, 3.0.2.3, 3.0.3.0, 3.0.4.0, 3.0.5.0, 3.2.0, 3.2.0.1, 3.2.1, 3.2.1.1
Change log ChangeLog.md
Dependencies base (==4.*), blaze-builder (>=0.2.1.4 && <0.5), bytestring (>=0.10), bytestring-builder (>=0.10.4.0 && <0.11), http-types (>=0.7), network (>=2.2.1.5), text (>=0.7), transformers (>=0.0), vault (==0.3.*) [details]
License MIT
Author Michael Snoyman
Maintainer michael@snoyman.com
Stability Stable
Category Web
Home page https://github.com/yesodweb/wai
Source repository head: git clone git://github.com/yesodweb/wai.git
head: git clone git://github.com/yesodweb/wai.git
Uploaded Tue May 24 02:52:49 UTC 2016 by MichaelSnoyman
Distributions Arch:3.2.1.1, Debian:3.0.5.0, Fedora:3.0.1.1, FreeBSD:3.0.3.0, LTSHaskell:3.2.1.1, NixOS:3.2.1.1, Stackage:3.2.1.1, Tumbleweed:3.2.1.1
Downloads 81478 total (194 in the last 30 days)
Votes
3 []
Status Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for wai

Readme for wai-3.2.1.1

WAI: Web Application Interface

Getting started

You want a minimal example? Here it is!

{-# LANGUAGE OverloadedStrings #-}
import Network.Wai
import Network.HTTP.Types
import Network.Wai.Handler.Warp (run)

app :: Application
app _ respond = do
    putStrLn "I've done some IO here"
    respond $ responseLBS
        status200
        [("Content-Type", "text/plain")]
        "Hello, Web!"

main :: IO ()
main = do
    putStrLn $ "http://localhost:8080/"
    run 8080 app

Put that code into a file named hello.hs and install wai and warp from Hackage:

cabal install wai warp

Run it:

runhaskell hello.hs

Point your browser to:

http://localhost:8080/

Serving static content

We can modify our previous example to serve static content. For this create a file named index.html:

<p>Hello, Web!</p>

Now we redefine responseBody to refer to that file:

app2 :: Application
app2 _ respond = respond index

index :: Response
index = responseFile
    status200
    [("Content-Type", "text/html")]
    "index.html"
    Nothing

Basic dispatching

An Application maps Requests to Responses:

ghci> :info  Application
type Application = Request -> IO Response

Depending on the path info provided with each Request we can serve different Responses:

app3 :: Application
app3 request respond = respond $ case rawPathInfo request of
    "/"     -> index
    "/raw/" -> plainIndex
    _       -> notFound

plainIndex :: Response
plainIndex = responseFile
    status200
    [("Content-Type", "text/plain")]
    "index.html"
    Nothing

notFound :: Response
notFound = responseLBS
    status404
    [("Content-Type", "text/plain")]
    "404 - Not Found"

Doing without overloaded strings

For the sake of efficiency, WAI uses the bytestring package. We used GHCs overloaded strings to almost hide this fact. But we can easily do without. What follows is a more verbose definition of notFound, that works without GHC extensions:

import qualified Data.ByteString.Char8 as B8
import qualified Data.ByteString.Lazy.Char8 as LB8
import           Data.CaseInsensitive (mk)

notFound = responseLBS
    status404
    [(mk $ B8.pack "Content-Type", B8.pack "text/plain")]
    (LB8.pack "404 - Not Found")