airship: A Webmachine-inspired HTTP library

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] [Publish]

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

Versions 0.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.2, 0.9.3, 0.9.4, 0.9.4
Change log Changes.md
Dependencies attoparsec, base (>=4.7 && <5), base64-bytestring (==1.0.*), blaze-builder (>=0.3 && <0.5), bytestring, bytestring-trie (>=0.2.4 && <0.2.6), case-insensitive, containers, cryptohash (==0.11.*), directory, either (>=4.3 && <6.0), filepath (>=1.3 && <1.5), http-date, http-media, http-types (>=0.8 && <0.13), lifted-base (==0.2.*), microlens, mime-types (==0.1.0.*), mmorph (>=1.0 && <1.2), monad-control (>=1.0), mtl, network, old-locale, random, semigroups (==0.18.*), text, time, transformers, transformers-base, unix (==2.7.*), unordered-containers, wai (>=3.0.3.0 && <3.2.2), wai-extra (>=3.0 && <3.0.26) [details]
License MIT
Author Reid Draper and Patrick Thomson
Maintainer Tim McGilchrist <timmcgil@gmail.com>
Category Web
Home page https://github.com/helium/airship/
Bug tracker https://github.com/helium/airship/issues
Source repo head: git clone https://github.com/helium/airship.git
Uploaded by lambda_foo at 2019-03-01T03:20:05Z

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for airship-0.9.4

[back to package description]

Airship

Join the chat at https://gitter.im/helium/airship

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.