Rename ApiQuasiQuoting.
And fix haddocks for it.
This commit is contained in:
parent
63584d52b7
commit
dee47654f9
6 changed files with 11 additions and 14 deletions
|
@ -31,8 +31,8 @@ library
|
||||||
Servant.Common.Req
|
Servant.Common.Req
|
||||||
Servant.Common.Text
|
Servant.Common.Text
|
||||||
Servant.Docs
|
Servant.Docs
|
||||||
|
Servant.QQ
|
||||||
Servant.Server
|
Servant.Server
|
||||||
Servant.Utils.ApiQuasiQuoting
|
|
||||||
Servant.Utils.Links
|
Servant.Utils.Links
|
||||||
Servant.Utils.StaticFiles
|
Servant.Utils.StaticFiles
|
||||||
build-depends:
|
build-depends:
|
||||||
|
|
|
@ -12,7 +12,7 @@ module Servant (
|
||||||
-- | Using your types in request paths and query string parameters
|
-- | Using your types in request paths and query string parameters
|
||||||
module Servant.Common.Text,
|
module Servant.Common.Text,
|
||||||
-- | Utilities on top of the servant core
|
-- | Utilities on top of the servant core
|
||||||
module Servant.Utils.ApiQuasiQuoting,
|
module Servant.QQ,
|
||||||
module Servant.Utils.Links,
|
module Servant.Utils.Links,
|
||||||
module Servant.Utils.StaticFiles,
|
module Servant.Utils.StaticFiles,
|
||||||
-- | Useful re-exports
|
-- | Useful re-exports
|
||||||
|
@ -25,6 +25,6 @@ import Servant.Client
|
||||||
import Servant.Common.Text
|
import Servant.Common.Text
|
||||||
import Servant.Docs
|
import Servant.Docs
|
||||||
import Servant.Server
|
import Servant.Server
|
||||||
import Servant.Utils.ApiQuasiQuoting
|
import Servant.QQ
|
||||||
import Servant.Utils.Links
|
import Servant.Utils.Links
|
||||||
import Servant.Utils.StaticFiles
|
import Servant.Utils.StaticFiles
|
||||||
|
|
|
@ -31,7 +31,7 @@ module Servant.API (
|
||||||
|
|
||||||
-- * Utilities
|
-- * Utilities
|
||||||
-- | QuasiQuotes for endpoints
|
-- | QuasiQuotes for endpoints
|
||||||
module Servant.Utils.ApiQuasiQuoting,
|
module Servant.QQ,
|
||||||
-- | Type-safe internal URLs
|
-- | Type-safe internal URLs
|
||||||
module Servant.Utils.Links,
|
module Servant.Utils.Links,
|
||||||
) where
|
) where
|
||||||
|
@ -46,6 +46,6 @@ import Servant.API.QueryParam
|
||||||
import Servant.API.Raw
|
import Servant.API.Raw
|
||||||
import Servant.API.ReqBody
|
import Servant.API.ReqBody
|
||||||
import Servant.API.Sub
|
import Servant.API.Sub
|
||||||
import Servant.Utils.ApiQuasiQuoting (sitemap)
|
import Servant.QQ (sitemap)
|
||||||
import Servant.Utils.Links (mkLink)
|
import Servant.Utils.Links (mkLink)
|
||||||
import Servant.Utils.StaticFiles
|
import Servant.Utils.StaticFiles
|
||||||
|
|
|
@ -21,12 +21,12 @@
|
||||||
--
|
--
|
||||||
-- @
|
-- @
|
||||||
-- "hello" :> ReqBody String :> Put ()
|
-- "hello" :> ReqBody String :> Put ()
|
||||||
-- :<|> "hello" :> Capture "p" Int :> ReqBody String :> Post ()
|
-- :\<|> "hello" :> Capture "p" Int :> ReqBody String :> Post ()
|
||||||
-- :<|> "hello" :> QueryParam "name" String :> Get Int
|
-- :\<|> "hello" :> QueryParam "name" String :> Get Int
|
||||||
-- @
|
-- @
|
||||||
--
|
--
|
||||||
-- Note the '/' before a 'QueryParam'!
|
-- Note the @/@ before a @QueryParam@!
|
||||||
module Servant.Utils.ApiQuasiQuoting where
|
module Servant.QQ where
|
||||||
|
|
||||||
import Control.Monad (void)
|
import Control.Monad (void)
|
||||||
import Control.Applicative hiding (many, (<|>), optional)
|
import Control.Applicative hiding (many, (<|>), optional)
|
||||||
|
@ -177,18 +177,14 @@ parseAll = do
|
||||||
-- | The sitemap QuasiQuoter.
|
-- | The sitemap QuasiQuoter.
|
||||||
--
|
--
|
||||||
-- * @.../<var>:<type>/...@ becomes a capture
|
-- * @.../<var>:<type>/...@ becomes a capture
|
||||||
--
|
|
||||||
-- * @.../?<var>:<type>@ becomes a query parameter
|
-- * @.../?<var>:<type>@ becomes a query parameter
|
||||||
--
|
|
||||||
-- * @<method> ... <typ>@ becomes a method returning @<typ>@
|
-- * @<method> ... <typ>@ becomes a method returning @<typ>@
|
||||||
--
|
|
||||||
-- * @<method> ... <typ1> -> <typ2>@ becomes a method with request
|
-- * @<method> ... <typ1> -> <typ2>@ becomes a method with request
|
||||||
-- body of @<typ1>@ and returning @<typ2>@
|
-- body of @<typ1>@ and returning @<typ2>@
|
||||||
--
|
--
|
||||||
-- Comments are allowed, and have the standard Haskell format
|
-- Comments are allowed, and have the standard Haskell format
|
||||||
--
|
--
|
||||||
-- * @--@ for inline
|
-- * @--@ for inline
|
||||||
--
|
|
||||||
-- * @{- ... -}@ for block
|
-- * @{- ... -}@ for block
|
||||||
--
|
--
|
||||||
sitemap :: QuasiQuoter
|
sitemap :: QuasiQuoter
|
|
@ -9,6 +9,7 @@
|
||||||
-- | Type safe internal links.
|
-- | Type safe internal links.
|
||||||
--
|
--
|
||||||
-- Provides the function 'mkLink':
|
-- Provides the function 'mkLink':
|
||||||
|
--
|
||||||
-- @
|
-- @
|
||||||
-- type API = Proxy ("hello" :> Get Int
|
-- type API = Proxy ("hello" :> Get Int
|
||||||
-- :<|> "bye" :> QueryParam "name" String :> Post Bool)
|
-- :<|> "bye" :> QueryParam "name" String :> Post Bool)
|
||||||
|
|
|
@ -7,7 +7,7 @@
|
||||||
{-# LANGUAGE TypeFamilies #-}
|
{-# LANGUAGE TypeFamilies #-}
|
||||||
{-# LANGUAGE TypeOperators #-}
|
{-# LANGUAGE TypeOperators #-}
|
||||||
{-# LANGUAGE UndecidableInstances #-}
|
{-# LANGUAGE UndecidableInstances #-}
|
||||||
module Servant.Utils.ApiQuasiQuotingSpec where
|
module Servant.Utils.QQSpec where
|
||||||
|
|
||||||
import Test.Hspec
|
import Test.Hspec
|
||||||
|
|
Loading…
Reference in a new issue