eeva/servant
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add QueryParamForm to API

Browse source
This commit is contained in:
Seongjun Kim 2017-04-11 01:02:58 +09:00
parent 86ad89b15c
commit 0897ae55ff
3 changed files with 17 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
servant/src/Servant/API.hs
View file

@ -71,7 +71,7 @@ import Servant.API.Header (Header (..))
import Servant.API.HttpVersion (HttpVersion (..)) import Servant.API.HttpVersion (HttpVersion (..))
import Servant.API.IsSecure (IsSecure (..)) import Servant.API.IsSecure (IsSecure (..))
import Servant.API.QueryParam (QueryFlag, QueryParam, import Servant.API.QueryParam (QueryFlag, QueryParam,
QueryParams) QueryParams, QueryParamForm)
import Servant.API.Raw (Raw) import Servant.API.Raw (Raw)
import Servant.API.RemoteHost (RemoteHost) import Servant.API.RemoteHost (RemoteHost)
import Servant.API.ReqBody (ReqBody) import Servant.API.ReqBody (ReqBody)

14
servant/src/Servant/API/QueryParam.hs
View file

@ -3,7 +3,7 @@
{-# LANGUAGE TypeOperators #-} {-# LANGUAGE TypeOperators #-}
{-# LANGUAGE PolyKinds #-} {-# LANGUAGE PolyKinds #-}
{-# OPTIONS_HADDOCK not-home #-} {-# OPTIONS_HADDOCK not-home #-}
module Servant.API.QueryParam (QueryFlag, QueryParam, QueryParams) where module Servant.API.QueryParam (QueryFlag, QueryParam, QueryParams, QueryParamForm) where
import Data.Typeable (Typeable) import Data.Typeable (Typeable)
import GHC.TypeLits (Symbol) import GHC.TypeLits (Symbol)
@ -42,9 +42,21 @@ data QueryParams (sym :: Symbol) a
-- >>> type MyApi = "books" :> QueryFlag "published" :> Get '[JSON] [Book] -- >>> type MyApi = "books" :> QueryFlag "published" :> Get '[JSON] [Book]
data QueryFlag (sym :: Symbol) data QueryFlag (sym :: Symbol)
-- | Lookup the values associated to the query string parameter
-- and try to extract it as a value of type @a@.
--
-- Example:
--
-- >>> -- /books?title=<title>&authors[]=<author1>&authors[]=<author2>&...
-- >>> type MyApi = "books" :> QueryParamForm BookSearchParams :> Get '[JSON] [Book]
data QueryParamForm a
deriving Typeable
-- $setup -- $setup
-- >>> import Servant.API -- >>> import Servant.API
-- >>> import Data.Aeson -- >>> import Data.Aeson
-- >>> import Data.Text -- >>> import Data.Text
-- >>> import Web.FormUrlEncoded (FromForm)
-- >>> data Book -- >>> data Book
-- >>> instance ToJSON Book where { toJSON = undefined } -- >>> instance ToJSON Book where { toJSON = undefined }
-- >>> data BookSearchParams

4
servant/src/Servant/API/TypeLevel.hs
View file

@ -51,7 +51,8 @@ import GHC.Exts (Constraint)
import Servant.API.Alternative (type (:<|>)) import Servant.API.Alternative (type (:<|>))
import Servant.API.Capture (Capture, CaptureAll) import Servant.API.Capture (Capture, CaptureAll)
import Servant.API.Header (Header) import Servant.API.Header (Header)
import Servant.API.QueryParam (QueryFlag, QueryParam, QueryParams) import Servant.API.QueryParam (QueryFlag, QueryParam,
QueryParams, QueryParamForm)
import Servant.API.ReqBody (ReqBody) import Servant.API.ReqBody (ReqBody)
import Servant.API.Sub (type (:>)) import Servant.API.Sub (type (:>))
import Servant.API.Verbs (Verb) import Servant.API.Verbs (Verb)
@ -123,6 +124,7 @@ type family IsElem endpoint api :: Constraint where
= IsElem sa sb = IsElem sa sb
IsElem sa (QueryParam x y :> sb) = IsElem sa sb IsElem sa (QueryParam x y :> sb) = IsElem sa sb
IsElem sa (QueryParams x y :> sb) = IsElem sa sb IsElem sa (QueryParams x y :> sb) = IsElem sa sb
IsElem sa (QueryParamForm x :> sb) = IsElem sa sb
IsElem sa (QueryFlag x :> sb) = IsElem sa sb IsElem sa (QueryFlag x :> sb) = IsElem sa sb
IsElem (Verb m s ct typ) (Verb m s ct' typ) IsElem (Verb m s ct typ) (Verb m s ct' typ)
= IsSubList ct ct' = IsSubList ct ct'