more haddocks

src/Servant.hs

@@ -7,10 +7,9 @@ module Servant (
   module Servant.Server,
   -- | For accessing servant APIs as API clients.
   module Servant.Client,
-  module Servant.Common.BaseUrl,
   -- | For generating documentation for servant APIs.
   module Servant.Docs,
-  -- | Helper module
+  -- | Using your types in request paths and query string parameters
   module Servant.Common.Text,
   -- | Utilities on top of the servant core
   module Servant.Utils.ApiQuasiQuoting,
@@ -23,7 +22,6 @@ module Servant (
 import Data.Proxy
 import Servant.API
 import Servant.Client
-import Servant.Common.BaseUrl
 import Servant.Common.Text
 import Servant.Docs
 import Servant.Server

src/Servant/API.hs

@@ -25,8 +25,9 @@ module Servant.API (
   module Servant.API.Put,
 
   -- * Untyped endpoints
-  -- | Plugging in a wai 'Network.Wai.Application'
+  -- | Plugging in a wai 'Network.Wai.Application', serving directories
   module Servant.API.Raw,
+  module Servant.Utils.StaticFiles,
 
   -- * Utilities
   -- | QuasiQuotes for endpoints
@@ -47,3 +48,4 @@ import Servant.API.ReqBody
 import Servant.API.Sub
 import Servant.Utils.ApiQuasiQuoting (sitemap)
 import Servant.Utils.Links (mkLink)
+import Servant.Utils.StaticFiles

src/Servant/API/Delete.hs

@@ -11,7 +11,6 @@ import Data.Typeable
 import Network.HTTP.Types
 import Network.Wai
 import Servant.Client
-import Servant.Common.BaseUrl
 import Servant.Common.Req
 import Servant.Docs
 import Servant.Server

src/Servant/API/Get.hs

@@ -12,7 +12,6 @@ import Data.Typeable
 import Network.HTTP.Types
 import Network.Wai
 import Servant.Client
-import Servant.Common.BaseUrl
 import Servant.Common.Req
 import Servant.Docs
 import Servant.Server

src/Servant/API/Post.hs

@@ -12,7 +12,6 @@ import Data.Typeable
 import Network.HTTP.Types
 import Network.Wai
 import Servant.Client
-import Servant.Common.BaseUrl
 import Servant.Common.Req
 import Servant.Docs
 import Servant.Server

src/Servant/API/Put.hs

@@ -12,7 +12,6 @@ import Data.Typeable
 import Network.HTTP.Types
 import Network.Wai
 import Servant.Client
-import Servant.Common.BaseUrl
 import Servant.Common.Req
 import Servant.Docs
 import Servant.Server

src/Servant/API/Raw.hs

@@ -9,7 +9,6 @@ import Data.Proxy
 import Network.HTTP.Types
 import Network.Wai
 import Servant.Client
-import Servant.Common.BaseUrl
 import Servant.Common.Req
 import Servant.Docs hiding (Method)
 import Servant.Server

src/Servant/Client.hs

@@ -1,17 +1,39 @@
 {-# LANGUAGE TypeFamilies #-}
 {-# LANGUAGE OverloadedStrings #-}
-module Servant.Client where
+-- | This module provides 'client' which can automatically generate
+-- querying functions for each endpoint just from the type representing your
+-- API.
+module Servant.Client
+  ( client
+  , HasClient(..)
+  , module Servant.Common.BaseUrl
+  ) where
 
 import Data.Proxy
 
+import Servant.Common.BaseUrl
 import Servant.Common.Req
 
 -- * Accessing APIs as a Client
 
 -- | 'client' allows you to produce operations to query an API from a client.
+--
+-- > type MyApi = "books" :> Get [Book] -- GET /books
+-- >         :<|> "books" :> ReqBody Book :> Post Book -- POST /books
+-- >
+-- > myApi :: Proxy MyApi
+-- > myApi = Proxy
+-- >
+-- > getAllBooks :: BaseUrl -> EitherT String IO [Book]
+-- > postNewBook :: Book -> BaseUrl -> EitherT String IO Book
+-- > (getAllBooks :<|> postNewBook) = client myApi
 client :: HasClient layout => Proxy layout -> Client layout
 client p = clientWithRoute p defReq
 
+-- | This class lets us define how each API combinator
+-- influences the creation of an HTTP request. Use 'client'
+-- directly, this class implements the client-side
+-- behavior of each combinator but you don't have to worry about it.
 class HasClient layout where
   type Client layout :: *
   clientWithRoute :: Proxy layout -> Req -> Client layout

src/Servant/Common/BaseUrl.hs

@@ -1,9 +1,6 @@
 {-# LANGUAGE DeriveGeneric #-}
 {-# LANGUAGE ViewPatterns #-}
-module Servant.Common.BaseUrl
+module Servant.Common.BaseUrl where
-  ( Scheme(..)
-  , BaseUrl (..)
-  ) where
 
 import Data.List
 import GHC.Generics

src/Servant/Common/Text.hs

@@ -1,7 +1,10 @@
 {-# LANGUAGE FlexibleInstances #-}
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE TypeSynonymInstances #-}
-module Servant.Common.Text where
+module Servant.Common.Text
+  ( FromText(..)
+  , ToText(..)
+  ) where
 
 import Data.String.Conversions
 import Data.Int
@@ -9,11 +12,11 @@ import Data.Text
 import Data.Text.Read
 import Data.Word
 
--- | For getting values from url captures, get parameters
+-- | For getting values from url captures and query string parameters
 class FromText a where
   fromText :: Text -> Maybe a
 
--- | For putting values in paths, get parameters
+-- | For putting values in paths and query string parameters
 class ToText a where
   toText :: a -> Text
 
@@ -29,11 +32,18 @@ instance FromText String where
 instance ToText String where
   toText = cs
 
+-- |
+-- > fromText "true"  = Just True
+-- > fromText "false" = Just False
+-- > fromText _       = Nothing
 instance FromText Bool where
   fromText "true"  = Just True
   fromText "false" = Just False
   fromText _       = Nothing
 
+-- |
+-- > toText True  = "true"
+-- > toText False = "false"
 instance ToText Bool where
   toText True  = "true"
   toText False = "false"

src/Servant/Docs.hs

@@ -4,14 +4,7 @@
 {-# LANGUAGE TemplateHaskell #-}
 
 -------------------------------------------------------------------------------
--- |
+-- | This module lets you get API docs for free. It lets generate
--- Module      : Servant.Docs
--- License     : BSD-style
--- Maintainer  : alpmestan@gmail.com
--- Stability   : provisional
--- Portability : TH, TypeFamilies, DeriveGeneric
---
--- This module lets you get API docs for free. It lets generate
 -- an 'API' from the type that represents your API using 'docs':
 --
 -- @docs :: 'HasDocs' api => 'Proxy' api -> 'API'@

src/Servant/Server.hs

@@ -1,10 +1,8 @@
 {-# LANGUAGE TypeFamilies #-}
 {-# LANGUAGE OverloadedStrings #-}
 
--- | This module lets you implement 'Server's for defined APIs.  You will
+-- | This module lets you implement 'Server's for defined APIs. You'll
--- probably need 'serve' (and look at the 'HasServer' type family), but
+-- most likely just need 'serve'.
--- 'toApplication' and 'route' are rather internals.
-
 module Servant.Server where
 
 import Data.Monoid
@@ -15,6 +13,22 @@ import Network.Wai
 -- * Implementing Servers
 
 -- | 'serve' allows you to implement an API and produce a wai 'Application'.
+--
+-- Example:
+--
+-- > type MyApi = "books" :> Get [Book] -- GET /books
+-- >         :<|> "books" :> ReqBody Book :> Post Book -- POST /books
+-- >
+-- > server :: Server MyApi
+-- > server = listAllBooks :<|> postBook
+-- >   where listAllBooks = ...
+-- >         postBook book = ...
+-- >
+-- > app :: Application
+-- > app = serve myApi server
+-- >
+-- > main :: IO ()
+-- > main = Network.Wai.Handler.Warp.run 8080 app
 serve :: HasServer layout => Proxy layout -> Server layout -> Application
 serve p server = toApplication (route p server)
 

src/Servant/Utils/StaticFiles.hs

@@ -10,7 +10,7 @@ import Network.HTTP.Types
 import Network.Wai
 import Network.Wai.Application.Static
 
-import Servant.API
+import Servant.API.Raw
 import Servant.Docs
 import Servant.Server
 

test/Servant/ClientSpec.hs

@@ -25,7 +25,6 @@ import Test.QuickCheck
 import Servant.API
 import Servant.Client
 import Servant.Server
-import Servant.Common.BaseUrl
 
 import Servant.ServerSpec