Servant.API.QueryString

Extract the whole query string from a request. This is useful for query strings containing dynamic parameter names. For query strings with static parameter names, QueryParam is more suited.

Example:

>>> -- /books?author=<author name>&year=<book year>>>> type MyApi = "books" :> QueryString :> Get '[JSON] [Book]

Extract an deep object from a query string.

Example:

>>> -- /books?filter[author][name]=<author name>&filter[year]=<book year>>>> type MyApi = "books" :> DeepQuery "filter" BookQuery :> Get '[JSON] [Book]

Extract a deep object from (possibly nested) query parameters. a param like filter[a][b][c]=d will be represented as '(["a", "b", "c"], Just "d")'. Note that a parameter with no nested field is possible: filter=a will be represented as '([], Just "a")'

Generate query parameters from an object, using the deep object syntax. A result of '(["a", "b", "c"], Just "d")' attributed to the filter parameter name will result in the following query parameter: filter[a][b][c]=d

Turn a nested path into a deep object query param

>>> generateDeepParam "filter" (["a", "b", "c"], Just "d")("filter[a][b][c]",Just "d")