scotty

Haskell web framework inspired by Ruby's Sinatra, using WAI and Warp

https://github.com/scotty-web/scotty

Version on this page:0.9.1@rev:2
LTS Haskell 22.34:0.20.1@rev:1
Stackage Nightly 2024-09-14:0.22@rev:2
Latest on Hackage:0.22@rev:2

See all snapshots scotty appears in

BSD-3-Clause licensed and maintained by Andrew Farmer
This version can be pinned in stack with:scotty-0.9.1@sha256:e37bd4bbb4da4e6d20bd8a29a5c3ca13476643e796a3463a20cbcbd2437bfde7,3955

Module documentation for 0.9.1

Used by 2 packages in lts-2.22(full list with versions):
blank-canvas, kansas-comet

Scotty Build StatusCoverage Status

A Haskell web framework inspired by Ruby’s Sinatra, using WAI and Warp.

{-# LANGUAGE OverloadedStrings #-}
import Web.Scotty

import Data.Monoid (mconcat)

main = scotty 3000 $ do
    get "/:word" $ do
        beam <- param "word"
        html $ mconcat ["<h1>Scotty, ", beam, " me up!</h1>"]

Scotty is the cheap and cheerful way to write RESTful, declarative web applications.

  • A page is as simple as defining the verb, url pattern, and Text content.
  • It is template-language agnostic. Anything that returns a Text value will do.
  • Conforms to WAI Application interface.
  • Uses very fast Warp webserver by default.

See examples/basic.hs to see Scotty in action. (basic.hs needs the wai-extra package)

> runghc examples/basic.hs
Setting phasers to stun... (port 3000) (ctrl-c to quit)
(visit localhost:3000/somepath)

As for the name: Sinatra + Warp = Scotty.

More Information

Tutorials and related projects can be found in the Scotty wiki:

https://github.com/scotty-web/scotty/wiki

Development & Support

Open an issue on GitHub or join #scotty on Freenode.

Copyright (c) 2012-2014 Andrew Farmer

Changes

0.9.1

  • Parsable instance for lazy bytestrings

  • jsonData now returns decoding error message

  • text/html/json only set Content-Type header when not already set

  • Bump monad-control to 1.0.0.0

0.9.0

  • Add charset=utf-8 to Content-Type for text, html and json

  • Assume HTTP status 500 for defaultHandler

  • Remove deprecated source method.

  • No longer depend on conduit.

0.8.2

  • Bump aeson upper bound

  • Fix mtl related deprecation warnings

0.8.1

  • Export internal types

  • Added MonadBase, MonadTransControl and MonadBaseControl instances for ActionT

0.8.0

  • Upgrade to wai/wai-extra/warp 3.0

  • No longer depend on conduit-extra.

  • The source response method has been deprecated in favor of a new stream response, matching changes in WAI 3.0.

  • Removed the deprecated reqHeader function.

0.7.3

  • Bump upper bound for case-insensitive, mtl and transformers.

0.7.2

  • Bump lower bound on conduit, add conduit-extra to cabal build depends.

0.7.1

  • Default warp settings now use setFdCacheDuration 0 to work around a warp issue where file changes are not getting picked up.

0.7.0

  • Renamed reqHeader to header. Added headers function to get all headers.

  • Changed MonadIO instance for ActionT such that IO exceptions are lifted into ScottyErrors via stringError.

  • Make Bool parsing case-insensitive. Goal: support both Haskell’s True/False and Javascript’s true/false. Thanks to Ben Gamari for suggesting this.

  • Bump aeson/text upper bounds.

  • Bump wai/wai-extra/warp bounds, including new lower bound for warp, which fixes a security issue related to Slowloris protection.

0.6.2

  • Bump upper bound for text.

0.6.1

  • Match changes in wai-extra.

0.6.0

  • The Scotty transformers (ScottyT and ActionT) are now parameterized over a custom exception type, allowing one to extend Scotty’s ErrorT layer with something richer than Text errors. See the exceptions example for use. ScottyM and ActionM remain specialized to Text exceptions for simplicity.

  • Both monads are now instances of Functor and Applicative.

  • There is a new cookies example.

  • Internals brought up-to-date with WAI 2.0 and related packages.

0.5.0

  • The Scotty monads (ScottyM and ActionM) are now monad transformers, allowing Scotty applications to be embedded in arbitrary MonadIOs. The old API continues to be exported from Web.Scotty where:

      type ScottyM = ScottyT IO
  type ActionM = ActionT IO

    The new transformers are found in Web.Scotty.Trans. See the globalstate example for use. Special thanks to Dan Frumin (co-dan) for much of the legwork here.

  • Added support for HTTP PATCH method.

  • Removed lambda action syntax. This will return when we have a better story for typesafe routes.

  • reqHeader :: Text -> ActionM Text ==> reqHeader :: Text -> ActionM (Maybe Text)

  • New raw method to set body to a raw ByteString

  • Parse error thrown by jsonData now includes the body it couldn’t parse.

  • header split into setHeader and addHeader. The former replaces a response header (original behavior). The latter adds a header (useful for multiple Set-Cookies, for instance).