The wai-routes package

[Tags:library, mit]

Provides easy to use typesafe URLs for Wai Applications. See README for more information. Also see examples/ directory for usage examples.


[Skip to Readme]

Properties

Versions 0.1, 0.2, 0.2.1, 0.2.2, 0.2.3, 0.2.4, 0.3.0, 0.3.1, 0.3.2, 0.3.3, 0.3.4, 0.4.0, 0.4.1, 0.5.0, 0.5.1, 0.6.0, 0.6.1, 0.6.2, 0.7.0, 0.7.1, 0.7.2, 0.7.3, 0.8.0, 0.8.1, 0.9.0, 0.9.1, 0.9.2, 0.9.3, 0.9.4, 0.9.5, 0.9.6, 0.9.7, 0.9.8
Dependencies aeson (>=0.8 && <0.12), base (>=4.7 && <4.9), blaze-builder (==0.4.*), bytestring (==0.10.*), case-insensitive (==1.2.*), containers (==0.5.*), cookie (==0.4.*), data-default-class (>=0.0 && <0.2), filepath (>=1.3 && <1.5), http-types (>=0.8 && <0.10), mime-types (==0.1.*), monad-loops (==0.4.*), mtl (>=2.1 && <2.3), path-pieces (==0.2.*), random (==1.1.*), template-haskell (>=2.9 && <2.12), text (==1.2.*), vault (==0.3.*), wai (>=3.0 && <3.3), wai-app-static (>=3.0 && <3.2), wai-extra (==3.0.*) [details]
License MIT
Author Anupam Jain
Maintainer ajnsit@gmail.com
Stability Experimental
Category Network
Home page https://ajnsit.github.io/wai-routes/
Source repository head: git clone http://github.com/ajnsit/wai-routes
this: git clone http://github.com/ajnsit/wai-routes/tree/v0.9.8(tag v0.9.8)
Uploaded Thu May 26 04:24:49 UTC 2016 by AnupamJain
Distributions LTSHaskell:0.9.8, NixOS:0.9.8
Downloads 3654 total (136 in the last 30 days)
Votes
1 []
Status Docs available [build log]
Last success reported on 2016-05-26 [all 1 reports]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for wai-routes

Readme for wai-routes-0.9.8

Wai-Routes Hackage Hackage-Deps Build Status Join the chat at <a href="https://gitter.im/ajnsit/wai-routes">https://gitter.im/ajnsit/wai-routes</a>

Wai-routes is a micro web framework for Haskell that focuses on typesafe URLs.

Wai-routes is based on the Haskell Web Application Interface and uses it for most of the heavy lifting. It also provides a convenient but thin veneer over most of the wai API so it is unnecessary to directly use raw wai APIs when building web apps.

Much of Wai-route's typesafe URL functionality was pulled from the corresponding features in Yesod, and indeed the underlying aim of wai-routes is - "To provide a similar level of typesafe URL functionality to Wai applications as is available to Yesod applications.".

Note - If you are looking for typesafe URLs for Snap, take a look at Snap-Routes - A port of this library for Snap.

Features

Wai-routes adds the following features on top of wai -

  • Typesafe URLs, including automatic boilerplate generation using TH. Including features such as -
    • Nested Routes
    • Subsites
    • Route Annotations
  • Seamlessly mix and match "unrouted" request handlers with typesafe routing.
  • Sitewide Master data which is passed to all handlers and can be used for persistent data (like DB connections)
  • Easy to use Handler Monad which allows direct access to request and master data
  • Easy composition of multiple routes and middleware to construct an application
  • Ability to abort processing and pass control to the next application in the wai stack
  • Streaming responses

Performance

When it comes to performance, Wai-routes compares quite favorably with other Haskell web development micro frameworks.

See more details here - philopon/apiary-benchmark

result

Example Usage

Wai-routes comes with several examples in the examples/ directory. New examples are being added regularly.

Example 1. Hello World - Code

A simple hello-world web app with two interlinked pages. This provides the simplest example of using routing and linking between pages with typesafe routes.

Example 2. Hello World with Subsites - Code

Similar functionality as the first example, but uses a hello world subsites to provide the hello world functionality. A subsite is an independently developed site that can be embedded into a parent site as long as the parent site satisfies a particular api contract. It's easy to swap out subsites for different functionality as long as the api contract remains constant.

Example 3. Using Blaze-HTML to generate HTML - Code

A simple example of how to generate HTML using blaze-html combinators in your handlers.

Example 4. Using Shakespearean Templates (hamlet, cassius, lucius, julius) to generate HTML/CSS/JS - Code

A simple example of how to generate HTML/CSS/JS using shakespearean templates. You can use both external and inline templates.

Example 5. Building a JSON REST Service - Code

Provides a simple example of how to build JSON REST services with wai-routes. Uses Aeson for JSON conversion. Note that this example just demonstrates the web facing side of the application. It doesn't permanently persist data, and is also not threadsafe. You must use a more robust data storage mechanism in production! An example of doing this with a Relational DB adapter (like persistent) is in the works.

Example 6. Stream a response - Code

Wai has had the ability to stream content for a long time. Now wai-routes exposes this functionality with the stream function. This example shows how to stream content in a handler. Note that most browsers using default settings will not show content as it is being streamed. You can use "curl" to observe the effect of streaming. E.g. - curl localhost:8080 will dump the data as it is being streamed from the server.

Example 7. Kitchen sink - Code

Work in progress. Demonstrates all major features in wai-routes.

Example 8. Unrouted - Code

Demonstrates "unrouted" applications. These require no TH, or GHC extensions. Basically allow you to sequence request handlers in a cascade, with each handler having the full functionality of HandlerM monad available to them. Each handler also has access to untyped (but parsed) route information. Unrouted handlers are freely mixable with typesafe routing.

Example 9. Typesafe "Bare" Wai routing - Code

Demonstrates writing no-overhead "bare" wai applications with routing. Wai-routes handlers are simple functions that return wai responses. This means that you are free to use typesafe routing, but without using runHandlerM, instead accessing the master datatype and the route args as arguments passed to the handler function.

Deployment

The current recommended route (pun not intended) for deploying wai-routes apps is keter. You need to read the port from the environment variables -

-- Run the application
main :: IO ()
main = do
  port' <- getEnv "PORT"
  let port = read port'
  run port $ waiApp application

Then put something like this in config/keter.yaml -

exec: ../path/to/executable
host: mydomainname.example.com

Then create a tarball with config/keter.yaml, path/to/executable, and any other files needed at runtime for your application. Rename the tarball to have a .keter extension.

Upload that file to your server's incoming folder for keter to pick it up. You obviously need keter already installed and configured properly at the server.

Planned Features

The following features are planned for later releases -

Changelog

  • 0.9.8 : Allow Data.Default-0.1.0. Allow comments in route definitions. Some other minor changes.
  • 0.9.7 : Allow Aeson-0.11. Export Env, RequestData, and show/readRoute to enable "bare" handlers.
  • 0.9.6 : Subsites now receive parent route arguments, in line with regular nested routes
  • 0.9.5 : Subsites now play well with hierarchical routes
  • 0.9.4 : Wai-3.2 compatibility. Added functions to manipulate wai "vault". Minor changes to internal types.
  • 0.9.3 : Added content and whenContent. Allow http-types-0.9.
  • 0.9.2 : Fix failing test in release tarball. (Only tests changed).
  • 0.9.1 : Greatly simplified subsites (simply use mkRouteSub). Added 'mountedAppHandler' to integrate external full wai apps.
  • 0.9.0 : Support for "unrouted" handlers. API changes to avoid returning lazy text or bytestring. Methods to fetch post/file params. Removed 'HandlerMM' and made 'Handler' more useful.
  • 0.8.1 : Bumped dependencies. Added 'HandlerMM' type alias
  • 0.8.0 : Replaced 'show/renderRoute' with 'show/renderRouteSub' and 'show/renderRouteMaster'. Added functions to access request headers (reqHeader/s), send a part of a file (filepart). Auto infer mime-types when sending files. Added cookie handling functions (get/setCookie/s). Added 'sub' to allow access to subsite datatype.
  • 0.7.3 : Added 'stream' to stream responses. Added 'asContent', 'css', and 'javascript' functions.
  • 0.7.2 : Added 'file' to send a raw file directly, 'rawBody' and 'jsonBody' to consume request body. Refactored RouteM to add 'catchAll' and 'waiApp'.
  • 0.7.1 : Added 'showRouteQuery', renamed 'text' to 'plain', 'html' now accepts Text instead of ByteString
  • 0.7.0 : Subsites support added
  • 0.6.2 : Added 'maybeRoute' and 'routeAttrSet', to get information about the currently executing route
  • 0.6.1 : Fixed cabal and travis files
  • 0.6.0 : Removed dependency on yesod-routes. Updated code to compile with wai-3 and ghc-7.8, ghc-7.10
  • 0.5.1 : Bumped dependency upper bounds to allow text 1.*
  • 0.5.0 : Added raw,text,html,json helpers. Update to wai-2.1.
  • 0.4.1 : showRoute now returns "/" instead of ""
  • 0.4.0 : Wai 2 compatibility. Replaced 'liftResourceT' with 'lift'
  • 0.3.4 : Added 'liftResourceT' to lift a ResourceT into HandlerM
  • 0.3.3 : Better exports from the Network.Wai.Middleware.Routes module
  • 0.3.2 : Added HandlerM Monad which makes it easier to build Handlers
  • 0.3.1 : Removed internal 'App' synonym which only muddied the types. Added common content types for convenience.
  • 0.3.0 : yesod-routes 1.2 compatibility. Abstracted request data. Created runNext which skips to the next app in the wai stack
  • 0.2.4 : Put an upper bound on yesod-routes version as 1.2 breaks API compatibility
  • 0.2.3 : Implemented a better showRoute function. Added blaze-builder as a dependency
  • 0.2.2 : Fixed license information in hs and cabal files
  • 0.2.1 : Changed license to MIT
  • 0.2 : Updated functionality based on yesod-routes package
  • 0.1 : Intial release