Web.Scotty

It should be noted that most of the code snippets below depend on the OverloadedStrings language pragma.

Scotty is set up by default for development mode. For production servers, you will likely want to modify settings and the defaultHandler. See the comments on each of these functions for more information.

scotty-to-WAI

scotty :: Port -> ScottyM () -> IO ()

Run a scotty application using the warp server.

scottyApp :: ScottyM () -> IO Application

Turn a scotty application into a WAI Application, which can be run with any WAI handler.

scottyOpts :: Options -> ScottyM () -> IO ()

Run a scotty application using the warp server, passing extra options.

scottySocket :: Options -> Socket -> ScottyM () -> IO ()

Run a scotty application using the warp server, passing extra options, and listening on the provided socket. This allows the user to provide, for example, a Unix named socket, which can be used when reverse HTTP proxying into your application.

data Options

Constructors

Options

Fields

• verbose :: Int

  0 = silent, 1(def) = startup banner

• settings :: Settings

  Warp Settings Note: to work around an issue in warp, the default FD cache duration is set to 0 so changes to static files are always picked up. This likely has performance implications, so you may want to modify this for production servers using setFdCacheDuration.

Instances

Default Options

Defined in Web.Scotty.Internal.Types

Methods

def :: Options

Defining Middleware and Routes

Middleware and routes are run in the order in which they are defined. All middleware is run first, followed by the first route that matches. If no route matches, a 404 response is given.

middleware :: Middleware -> ScottyM ()

Use given middleware. Middleware is nested such that the first declared is the outermost middleware (it has first dibs on the request and last action on the response). Every middleware is run on each request.

get :: RoutePattern -> ActionM () -> ScottyM ()

get = addroute GET

post :: RoutePattern -> ActionM () -> ScottyM ()

post = addroute POST

put :: RoutePattern -> ActionM () -> ScottyM ()

put = addroute PUT

delete :: RoutePattern -> ActionM () -> ScottyM ()

delete = addroute DELETE

patch :: RoutePattern -> ActionM () -> ScottyM ()

patch = addroute PATCH

options :: RoutePattern -> ActionM () -> ScottyM ()

options = addroute OPTIONS

addroute :: StdMethod -> RoutePattern -> ActionM () -> ScottyM ()

Define a route with a StdMethod, Text value representing the path spec, and a body (Action) which modifies the response.

addroute GET "/" $ text "beam me up!"

The path spec can include values starting with a colon, which are interpreted as captures. These are named wildcards that can be looked up with param.

addroute GET "/foo/:bar" $ do
    v <- param "bar"
    text v

>>> curl http://localhost:3000/foo/something
something

matchAny :: RoutePattern -> ActionM () -> ScottyM ()

Add a route that matches regardless of the HTTP verb.

notFound :: ActionM () -> ScottyM ()

Specify an action to take if nothing else is found. Note: this _always_ matches, so should generally be the last route specified.

setMaxRequestBodySize :: Kilobytes -> ScottyM ()

Set global size limit for the request body. Requests with body size exceeding the limit will not be processed and an HTTP response 413 will be returned to the client. Size limit needs to be greater than 0, otherwise the application will terminate on start.

Route Patterns

capture :: String -> RoutePattern

Standard Sinatra-style route. Named captures are prepended with colons. This is the default route type generated by OverloadedString routes. i.e.

get (capture "/foo/:bar") $ ...

and

{-# LANGUAGE OverloadedStrings #-}
...
get "/foo/:bar" $ ...

are equivalent.

regex :: String -> RoutePattern

Match requests using a regular expression. Named captures are not yet supported.

get (regex "^/f(.*)r$") $ do
   path <- param "0"
   cap <- param "1"
   text $ mconcat ["Path: ", path, "\nCapture: ", cap]

>>> curl http://localhost:3000/foo/bar
Path: /foo/bar
Capture: oo/ba

function :: (Request -> Maybe [Param]) -> RoutePattern

Build a route based on a function which can match using the entire Request object. Nothing indicates the route does not match. A Just value indicates a successful match, optionally returning a list of key-value pairs accessible by param.

get (function $ \req -> Just [("version", pack $ show $ httpVersion req)]) $ do
    v <- param "version"
    text v

>>> curl http://localhost:3000/
HTTP/1.1

literal :: String -> RoutePattern

Build a route that requires the requested path match exactly, without captures.

Accessing the Request, Captures, and Query Parameters

request :: ActionM Request

Get the Request object.

header :: Text -> ActionM (Maybe Text)

Get a request header. Header name is case-insensitive.

headers :: ActionM [(Text, Text)]

Get all the request headers. Header names are case-insensitive.

body :: ActionM ByteString

Get the request body.

bodyReader :: ActionM (IO ByteString)

Get an IO action that reads body chunks

• This is incompatible with body since body consumes all chunks.

param :: Parsable a => Text -> ActionM a

Get a parameter. First looks in captures, then form data, then query parameters.

• Raises an exception which can be caught by rescue if parameter is not found.
• If parameter is found, but read fails to parse to the correct type, next is called. This means captures are somewhat typed, in that a route won't match if a correctly typed capture cannot be parsed.

params :: ActionM [Param]

Get all parameters from capture, form and query (in that order).

jsonData :: FromJSON a => ActionM a

Parse the request body as a JSON object and return it. Raises an exception if parse is unsuccessful.

files :: ActionM [File]

Get list of uploaded files.

Modifying the Response and Redirecting

status :: Status -> ActionM ()

Set the HTTP response status. Default is 200.

addHeader :: Text -> Text -> ActionM ()

Add to the response headers. Header names are case-insensitive.

setHeader :: Text -> Text -> ActionM ()

Set one of the response headers. Will override any previously set value for that header. Header names are case-insensitive.

redirect :: Text -> ActionM a

Redirect to given URL. Like throwing an uncatchable exception. Any code after the call to redirect will not be run.

redirect "http://www.google.com"

OR

redirect "/foo/bar"

Setting Response Body

Note: only one of these should be present in any given route definition, as they completely replace the current Response body.

text :: Text -> ActionM ()

Set the body of the response to the given Text value. Also sets "Content-Type" header to "text/plain; charset=utf-8" if it has not already been set.

html :: Text -> ActionM ()

Set the body of the response to the given Text value. Also sets "Content-Type" header to "text/html; charset=utf-8" if it has not already been set.

file :: FilePath -> ActionM ()

Send a file as the response. Doesn't set the "Content-Type" header, so you probably want to do that on your own with setHeader.

json :: ToJSON a => a -> ActionM ()

Set the body of the response to the JSON encoding of the given value. Also sets "Content-Type" header to "application/json; charset=utf-8" if it has not already been set.

stream :: StreamingBody -> ActionM ()

Set the body of the response to a StreamingBody. Doesn't set the "Content-Type" header, so you probably want to do that on your own with setHeader.

raw :: ByteString -> ActionM ()

Set the body of the response to the given ByteString value. Doesn't set the "Content-Type" header, so you probably want to do that on your own with setHeader.

Exceptions

raise :: Text -> ActionM a

Throw an exception, which can be caught with rescue. Uncaught exceptions turn into HTTP 500 responses.

raiseStatus :: Status -> Text -> ActionM a

Throw an exception, which can be caught with rescue. Uncaught exceptions turn into HTTP responses corresponding to the given status.

rescue :: ActionM a -> (Text -> ActionM a) -> ActionM a

Catch an exception thrown by raise.

raise "just kidding" `rescue` (\msg -> text msg)

next :: ActionM a

Abort execution of this action and continue pattern matching routes. Like an exception, any code after next is not executed.

As an example, these two routes overlap. The only way the second one will ever run is if the first one calls next.

get "/foo/:bar" $ do
  w :: Text <- param "bar"
  unless (w == "special") next
  text "You made a request to /foo/special"

get "/foo/:baz" $ do
  w <- param "baz"
  text $ "You made a request to: " <> w

finish :: ActionM a

Abort execution of this action. Like an exception, any code after finish is not executed.

As an example only requests to /foo/special will include in the response content the text message.

get "/foo/:bar" $ do
  w :: Text <- param "bar"
  unless (w == "special") finish
  text "You made a request to /foo/special"

Since: 0.10.3

defaultHandler :: (Text -> ActionM ()) -> ScottyM ()

Global handler for uncaught exceptions.

Uncaught exceptions normally become 500 responses. You can use this to selectively override that behavior.

Note: IO exceptions are lifted into Scotty exceptions by default. This has security implications, so you probably want to provide your own defaultHandler in production which does not send out the error strings as 500 responses.

liftAndCatchIO :: IO a -> ActionM a

Like liftIO, but catch any IO exceptions and turn them into Scotty exceptions.

Parsing Parameters

type Param = (Text, Text)

class Parsable a where

Minimum implemention: parseParam

Minimal complete definition

parseParam

Methods

parseParam :: Text -> Either Text a

Take a Text value and parse it as a, or fail with a message.

parseParamList :: Text -> Either Text [a]

Default implementation parses comma-delimited lists.

parseParamList t = mapM parseParam (T.split (== ',') t)

Instances

Parsable Int16

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text Int16

parseParamList :: Text -> Either Text [Int16]

Parsable Int32

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text Int32

parseParamList :: Text -> Either Text [Int32]

Parsable Int64

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text Int64

parseParamList :: Text -> Either Text [Int64]

Parsable Int8

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text Int8

parseParamList :: Text -> Either Text [Int8]

Parsable Word16

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text Word16

parseParamList :: Text -> Either Text [Word16]

Parsable Word32

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text Word32

parseParamList :: Text -> Either Text [Word32]

Parsable Word64

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text Word64

parseParamList :: Text -> Either Text [Word64]

Parsable Word8

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text Word8

parseParamList :: Text -> Either Text [Word8]

Parsable ByteString

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text ByteString

parseParamList :: Text -> Either Text [ByteString]

Parsable ByteString

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text ByteString

parseParamList :: Text -> Either Text [ByteString]

Parsable Text

Defined in Web.Scotty.Action

Methods

parseParam :: Text0 -> Either Text0 Text

parseParamList :: Text0 -> Either Text0 [Text]

Parsable Text

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text Text

parseParamList :: Text -> Either Text [Text]

Parsable Integer

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text Integer

parseParamList :: Text -> Either Text [Integer]

Parsable Natural

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text Natural

parseParamList :: Text -> Either Text [Natural]

Parsable ()

Checks if parameter is present and is null-valued, not a literal (). If the URI requested is: '/foo?bar=()&baz' then baz will parse as (), where bar will not.

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text ()

parseParamList :: Text -> Either Text [()]

Parsable Bool

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text Bool

parseParamList :: Text -> Either Text [Bool]

Parsable Char

Overrides default parseParamList to parse String.

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text Char

parseParamList :: Text -> Either Text [Char]

Parsable Double

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text Double

parseParamList :: Text -> Either Text [Double]

Parsable Float

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text Float

parseParamList :: Text -> Either Text [Float]

Parsable Int

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text Int

parseParamList :: Text -> Either Text [Int]

Parsable Word

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text Word

parseParamList :: Text -> Either Text [Word]

Parsable a => Parsable [a]

Defined in Web.Scotty.Action

Methods

parseParam :: Text -> Either Text [a]

parseParamList :: Text -> Either Text [[a]]

readEither :: Read a => Text -> Either Text a

Useful for creating Parsable instances for things that already implement Read. Ex:

instance Parsable Int where parseParam = readEither

Types

type ScottyM = ScottyT Text IO

type ActionM = ActionT Text IO

data RoutePattern

Instances

IsString RoutePattern

Defined in Web.Scotty.Internal.Types

Methods

fromString :: String -> RoutePattern

type File = (Text, FileInfo ByteString)

type Kilobytes = Int