apiary

Simple and type safe web framework that generate web API documentation.

https://github.com/philopon/apiary

Version on this page:2.0.2
LTS Haskell 6.35:2.0.2
Stackage Nightly 2016-05-25:2.0.2
Latest on Hackage:2.1.2@rev:1

See all snapshots apiary appears in

MIT licensed and maintained by HirotomoMoriwaki<[email protected]>
This version can be pinned in stack with:apiary-2.0.2@sha256:0b90f50b78ee76e0bd916d7c5b7ff9870ddd28cffa61d18d917d03c39f4fc1bb,6659

Module documentation for 2.0.2

Simple and type safe web framework that can be automatically generate API documentation.

{-# LANGUAGE QuasiQuotes #-}
{-# LANGUAGE OverloadedStrings #-}

import Web.Apiary
import Network.Wai.Handler.Warp
import qualified Data.ByteString.Lazy.Char8 as L

main :: IO ()
main = runApiary (run 3000) def $ do
  [capture|/age::Int|] . ([key|name|] =: pLazyByteString) . method GET . action $ do
      (age, name) <- [params|age,name|]
      guard (age >= 18)
      contentType "text/html"
      mapM_ appendLazyBytes ["<h1>Hello, ", name, "!</h1>\n"]

$ curl localhost:3000
404 Page Notfound.
$ curl 'localhost:3000/20?name=arice'
<h1>Hello, arice!</h1>
$ curl 'localhost:3000/15?name=bob'
404 Page Notfound.
$ curl -XPOST 'localhost:3000/20?name=arice'
404 Page Notfound.

more examples: https://github.com/philopon/apiary/blob/v1.4.0/examples/

live demo: http://find-hackage.herokuapp.com/ (source code: https://github.com/philopon/find-hackage)

Changes

2.0.2

  • add json to send ToJson instances with auto ‘application/json’ content type.

2.0.1

  • document Data.Param.File
  • expose Control.Monad.Apiary.Action.getReqBodyJSON

2.0.0

  • add methods to get application from Apiary monad stack.
  • add Control.Monad.Apiary.Action.application to mount a wai application at certain route.
  • rewrite getReqBody to allow file upload with temp file backend, check out ApiaryConfig and Data.Param.File.
  • guard against large request body.
  • add Control.Monad.Filter.jsonReqBody to do type level route based on request body’s JSON type.

1.4.5

  • fix: MonadPlus lows of ApiaryT Monad

1.4.4

  • use wai-extra to parse request body

1.4.3

  • ghc-7.10 compatible

1.4.2

  • fix: remove async from API document

1.4.1

  • add viewport, charset, and async to auto generate API document

1.4.0

  • remove Data.Apiary.Compat module
  • remove bytestring-lexing(and alex) dependency

1.3.0

  • new router(web-routing package)

  • new dictionary

    insert -> add NotMember -> (</) etc…

  • add Filter,Filter’ type

  • remove focus’

    focus’ -> focus focus -> [delete]

  • change boolean query behaviour

    old: ?key == fail new: ?key == true

1.2.3

  • fix haddock documentation.

1.2.2

  • export getReqBody.

1.2.1

  • reduce dependencies.
  • relax version restriction of monad-control.
  • move pure capture function.
  • export hoistActionT, focus’, noExtension.

1.2.0

  • good bye wai-2.
  • add Web.Apiary.Develop module for develop static file.
  • change response body function behaviour(append to set).
  • add append* functions.
  • remove MonadHas class. add MonadExt class.
  • add action vault for extension.
  • change binary package to cereal package.

apiary-websockets

  • fix actionWithWebSockets don’t exec action.

apiary-session/apiary-clientsession/apiary-authenticate

  • new session system.

1.1.4

  • enhance API documentation.
  • add MonadHas class.
  • add devFile action.

1.1.3

  • wildcard, parameter Accept header.

apiary-mongoDB(1.1.1)

  • MongoAccess class

apiary-logger(1.1.1)

  • Logging class

apiary-persistent(1.1.1)

  • RunSQL class

1.1.2

  • re-export Web.Apiary from Web.Apiary.Heroku.

1.1.1

  • add request test to web API documentation.

1.1.0

  • Added Extension class. now Extension can add middleware.
  • Added apiary-helics submodule.

1.0.0

  • included named parameter. motivation:

    changing filter order

    filterA . filterB . action $ \a b -> act to

    filterB . filterA . action $ \b a -> act ~~~ changes argument order. it’s too bad…

  • simplified Strategy type class.

  • removed DEPRECATED functions.

  • changed runner type.

  • changed module structure.

  • API freeze. I’ll pay attention to compatibility, maybe…

0.17.2

  • send 302 if file not midified.

0.17.1

  • relax switchQuery.

            old   new

    key True True key=true False True key=false False False

0.17.0

  • fix not accept in multi Accept header.
  • add greedy path capture(’**’).
  • add switchQuery filter.
  • add Heroku module.
  • add google analytics support to API documentation.

Extension API

  • change interface.
  • fix bug which immediately finalize.
  • deprecate preAction.
  • Category initializer only ghc-7.8+.

new extensions

  • apiary-mongoDB
  • apiary-memcached

0.16.0

  • new Extension API.
  • add middleware function.
  • remove Typeable restriction from Path/Query class.
  • add Optional strategy, (=?!:) query fetcher.
  • add accept filter.
  • add Path/Query instances to Day.

0.15.2

  • you can set status and response headers anywhere.
  • deprecate lbs.
  • add bytes, lazyBytes(~ lbs), text, lazyText, showing, string, char request body functions. these functions append request body.
  • add reset function to reset request body to empty.

0.15.1

  • enhance performance(especially parsing parameter).

0.15.0

  • enhance performance(new router).
  • add anyPath function.

0.14.0

  • change First Strategy behaviour(check first param only).
  • merge method and stdMethod function.
  • rename function (response -> rawResponse)
  • add apiary-purescript

documentation

  • changed how to generate documentation. use defaultDocumentationAction action.
  • now, condition which is after document function, will be documented. use noDoc function.
  • abolish ‘:’ query document api. use (??) function.
  • deprecated () route decument api. use [].

0.13.0

  • Option that generate full embed documentation.
  • Add precondition, rpHtml functions.

API documentation page

  • precondition
  • multi action
  • use route string as id of html

0.12.8

  • Option that doesn’t generate documentation.
  • Change fail of ActionT behaviour. ( Pass next action -> return 500 error immediately.)

API documentation page

  • collapse

0.12.5

  • Enhance API documentation.
  • Description using variable.

0.12.0

  • Automatically generate API documentation.
  • Remove Functor restriction from ApiaryT.

0.11.1

  • Generalize proxy.
  • Fix capture behaviour.
  • Add endPath function.

0.11.0

  • Change capture internal implimentation.
  • Add path, fetch pure capture function.

apiary-clientsession

  • Add prefix SessionConfig fields.

0.10.0

  • wai-3.0.
  • Add response function.
  • Add MonadCatch, MonadMask instances to ActionT.