Safe Haskell	Safe
Language	Haskell2010

Network.API.Builder.Routes

Synopsis

Documentation

data Route Source #

Main type for routes in the API. Used to represent the URL minus the actual endpoint URL as well as the query string and the HTTP method used to communicate with the server.

Constructors

Route
Fields urlPieces :: [URLPiece] urlParams :: [URLParam] httpMethod :: Method

Instances

Eq Route Source #
Methods (==) :: Route -> Route -> Bool # (/=) :: Route -> Route -> Bool #
Read Route Source #
Methods readsPrec :: Int -> ReadS Route # readList :: ReadS [Route] # readPrec :: ReadPrec Route # readListPrec :: ReadPrec [Route] #
Show Route Source #
Methods showsPrec :: Int -> Route -> ShowS # show :: Route -> String # showList :: [Route] -> ShowS #

type URLPiece = Text Source #

Alias for Text to store the URL fragments for each Route.

type URLParam = [(Text, Text)] Source #

Alias to (Text, Maybe Text) used to store each query that gets tacked onto the request.

(=.) :: ToQuery a => Text -> a -> [(Text, Text)] Source #

Convenience function for building URLParams. Right-hand argument must have a ToQuery instance so it can be converted to the appropriate representation in a query string. Query values do not need to be escaped.

>>> "api_type" =. ("json" :: Text)
("api_type", Just "json")

routeURL Source #

Arguments

:: Text	base URL for the `Route` (you can usually get this from the `Builder`)
-> Route	the `Route` to process
-> Text	the finalized URL as a `Text`

Converts a Route to a URL. Drops any Nothing values from the query, separates the fragments with "/" and tacks them onto the end of the base URL.