The airship package

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain]

A Webmachine-inspired HTTP library based off ideas from the original Erlang project https://github.com/webmachine/webmachine

A number of examples can be found in https://github.com/helium/airship/tree/master/example illustrating how to build airship based services.


[Skip to ReadMe]

Properties

Versions0.1.0.0, 0.2.0.0, 0.3.0.0, 0.4.0.0, 0.4.1.0, 0.4.2.0, 0.4.3.0, 0.5.0, 0.6.0, 0.9.0, 0.9.1, 0.9.1, 0.9.2
Change logChanges.md
Dependenciesattoparsec, base (>=4.7 && <5), base64-bytestring (==1.0.*), blaze-builder (>=0.3 && <0.5), bytestring, bytestring-trie (==0.2.4.*), case-insensitive, containers, cryptohash (==0.11.*), directory, either (>=4.3 && <4.6), filepath (>=1.3 && <1.5), http-date, http-media, http-types (>=0.8 && <0.10), lifted-base (==0.2.*), microlens, mime-types (==0.1.0.*), mmorph (>=1.0 && <1.2), monad-control (>=1.0), mtl, network, old-locale, random, text, time, transformers, transformers-base, unix (==2.7.*), unordered-containers, wai (>=3.0 && <3.3), wai-extra (==3.0.*) [details]
LicenseMIT
AuthorReid Draper and Patrick Thomson
MaintainerTim McGilchrist <timmcgil@gmail.com>, reid@helium.com
CategoryWeb
Home pagehttps://github.com/helium/airship/
Bug trackerhttps://github.com/helium/airship/issues
Source repositoryhead: git clone https://github.com/helium/airship.git
UploadedFri Dec 1 04:06:59 UTC 2017 by lambda_foo

Modules

[Index]

Downloads

Maintainers' corner

For package maintainers and hackage trustees


Readme for airship-0.9.1

[back to package description]

Airship

Join the chat at <a href="https://gitter.im/helium/airship">https://gitter.im/helium/airship</a>

Build Status

Airship is a Haskell library for handling and serving HTTP requests in a RESTful fashion. It is heavily inspired by Webmachine and works with any WAI-compatible web server such as Warp. It aims to be small, fast, and flexible.

How does it work?

Airship resources are represented with a Resource record type. Each field in Resource corresponds to an action taken in the Webmachine decision tree. Airship provides a defaultResource with sensible defaults for each of these actions; you build web services by overriding fields in the default resource with your own.

Routes are declared with a simple monadic syntax:

routes = do
    root                        #> someRootResource
    "account" </> var "name"    #> accountResource

For a simple example that handles HTTP GET and POST requests, please check example/Basic.hs. For a slightly more involved example that generates HTML and manages a pool of resources, please check the blimp repository.

Airship is copyright © 2015 Helium Systems, Inc., and released to the public under the terms of the MIT license.