servant/servant.cabal

name:                servant
version:             0.2
synopsis:            A family of combinators for defining webservices APIs and serving them
description:
  A family of combinators for defining webservices APIs and serving them
  .
  You can learn about the basics in <http://haskell-servant.github.io/getting-started/ the getting started> guide.
  .
  Here's a runnable example, with comments, that defines a dummy API and
  implements a webserver that serves this API. You can find it <https://github.com/haskell-servant/servant/blob/master/example/greet.hs here> too.
  .
  > {-# LANGUAGE DataKinds #-}
  > {-# LANGUAGE PolyKinds #-}
  > {-# LANGUAGE TypeFamilies #-}
  > {-# LANGUAGE DeriveGeneric #-}
  > {-# LANGUAGE TypeOperators #-}
  > {-# LANGUAGE OverloadedStrings #-}
  >
  > import Data.Aeson
  > import Data.Monoid
  > import Data.Proxy
  > import Data.Text
  > import GHC.Generics
  > import Network.Wai
  > import Network.Wai.Handler.Warp
  >
  > import Servant
  >
  > -- * Example
  >
  > -- | A greet message data type
  > newtype Greet = Greet { msg :: Text }
  >   deriving (Generic, Show)
  >
  > instance FromJSON Greet
  > instance ToJSON Greet
  >
  > -- API specification
  > type TestApi =
  >        -- GET /hello/:name?capital={true, false}
           --     returns a Greet as JSON
  >        "hello" :> Capture "name" Text :> QueryParam "capital" Bool :> Get Greet
  >
  >        -- POST /greet with a Greet as JSON in the request body,
  >        --      returns a Greet as JSON
  >   :<|> "greet" :> ReqBody Greet :> Post Greet
  >
  >        -- DELETE /greet/:greetid
  >   :<|> "greet" :> Capture "greetid" Text :> Delete
  >
  > testApi :: Proxy TestApi
  > testApi = Proxy
  >
  > -- Server-side handlers.
  > --
  > -- There's one handler per endpoint, which, just like in the type
  > -- that represents the API, are glued together using :<|>.
  > --
  > -- Each handler runs in the 'EitherT (Int, String) IO' monad.
  > server :: Server TestApi
  > server = helloH :<|> postGreetH :<|> deleteGreetH
  >
  >   where helloH name Nothing = helloH name (Just False)
  >         helloH name (Just False) = return . Greet $ "Hello, " <> name
  >         helloH name (Just True) = return . Greet . toUpper $ "Hello, " <> name
  >
  >         postGreetH greet = return greet
  >
  >         deleteGreetH _ = return ()
  >
  > -- Turn the server into a WAI app. 'serve' is provided by servant,
  > -- more precisely by the Servant.Server module.
  > test :: Application
  > test = serve testApi server
  >
  > -- Run the server.
  > --
  > -- 'run' comes from Network.Wai.Handler.Warp
  > runTestServer :: Port -> IO ()
  > runTestServer port = run port test
  >
  > -- Put this all to work!
  > main :: IO ()
  > main = runTestServer 8001
homepage:            http://haskell-servant.github.io/
Bug-reports:         http://github.com/haskell-servant/servant/issues
license:             BSD3
license-file:        LICENSE
author:              Alp Mestanogullari, Sönke Hahn, Julian K. Arni
maintainer:          alpmestan@gmail.com
copyright:           2014 Zalora South East Asia Pte Ltd
category:            Web
build-type:          Simple
cabal-version:       >=1.10
tested-with:         GHC >= 7.8
source-repository head
  type: git
  location: http://github.com/haskell-servant/servant.git

library
  exposed-modules:
    Servant
    Servant.API
    Servant.API.Alternative
    Servant.API.Capture
    Servant.API.Delete
    Servant.API.Get
    Servant.API.Post
    Servant.API.Put
    Servant.API.QueryParam
    Servant.API.Raw
    Servant.API.ReqBody
    Servant.API.Sub
    Servant.Common.Text
    Servant.QQ
    Servant.Server
    Servant.Utils.Links
    Servant.Utils.StaticFiles
  build-depends:
      base >=4.7 && <5
    , aeson
    , attoparsec
    , bytestring
    , either
    , http-types
    , network-uri >= 2.6
    , parsec
    , safe
    , split
    , string-conversions
    , system-filepath
    , template-haskell
    , text
    , transformers
    , wai
    , wai-app-static
    , warp
  hs-source-dirs: src
  default-language: Haskell2010
  ghc-options: -Wall

executable greet
  main-is: greet.hs
  hs-source-dirs: example
  ghc-options: -Wall
  default-language: Haskell2010
  build-depends:
      base
    , servant
    , aeson
    , warp
    , wai
    , text

test-suite spec
  type: exitcode-stdio-1.0
  ghc-options:
    -Wall -fno-warn-name-shadowing -fno-warn-missing-signatures
  default-language: Haskell2010
  hs-source-dirs: test
  main-is: Spec.hs
  build-depends:
      base == 4.*
    , aeson
    , bytestring
    , directory
    , either
    , exceptions
    , hspec == 2.*
    , hspec-wai
    , http-types
    , network >= 2.6
    , QuickCheck
    , parsec
    , servant
    , string-conversions
    , temporary
    , text
    , transformers
    , wai
    , wai-extra
    , warp