Mig.Core.Api

Core API description

Documentation

data Api a

HTTP API container

Constructors

Append (Api a) (Api a)

alternative between two API's

Empty

an empty API that does nothing

WithPath Path (Api a)

path prefix for an API

HandleRoute a

handle route

Instances

Foldable Api

Defined in Mig.Core.Api

Methods

fold :: Monoid m => Api m -> m

foldMap :: Monoid m => (a -> m) -> Api a -> m

foldMap' :: Monoid m => (a -> m) -> Api a -> m

foldr :: (a -> b -> b) -> b -> Api a -> b

foldr' :: (a -> b -> b) -> b -> Api a -> b

foldl :: (b -> a -> b) -> b -> Api a -> b

foldl' :: (b -> a -> b) -> b -> Api a -> b

foldr1 :: (a -> a -> a) -> Api a -> a

foldl1 :: (a -> a -> a) -> Api a -> a

toList :: Api a -> [a]

null :: Api a -> Bool

length :: Api a -> Int

elem :: Eq a => a -> Api a -> Bool

maximum :: Ord a => Api a -> a

minimum :: Ord a => Api a -> a

sum :: Num a => Api a -> a

product :: Num a => Api a -> a

Traversable Api

Defined in Mig.Core.Api

Methods

traverse :: Applicative f => (a -> f b) -> Api a -> f (Api b)

sequenceA :: Applicative f => Api (f a) -> f (Api a)

mapM :: Monad m => (a -> m b) -> Api a -> m (Api b)

sequence :: Monad m => Api (m a) -> m (Api a)

Functor Api

Defined in Mig.Core.Api

Methods

fmap :: (a -> b) -> Api a -> Api b

(<$) :: a -> Api b -> Api a

Monoid (Api a)

Defined in Mig.Core.Api

Methods

mempty :: Api a

mappend :: Api a -> Api a -> Api a

mconcat :: [Api a] -> Api a

Semigroup (Api a)

Defined in Mig.Core.Api

Methods

(<>) :: Api a -> Api a -> Api a

sconcat :: NonEmpty (Api a) -> Api a

stimes :: Integral b => b -> Api a -> Api a

Show a => Show (Api a)

Defined in Mig.Core.Api

Methods

showsPrec :: Int -> Api a -> ShowS

show :: Api a -> String

showList :: [Api a] -> ShowS

Eq a => Eq (Api a)

Defined in Mig.Core.Api

Methods

(==) :: Api a -> Api a -> Bool

(/=) :: Api a -> Api a -> Bool

newtype Path

Path is a chain of elements which can be static types or capture. There is IsString instance which allows us to create paths from strings. Examples:

"api/v1/foo" ==> Path [StaticPath "api", StaticPath "v1", StaticPath "foo"]
"api/v1/*" ==> Path [StaticPath "api", StaticPath "v1", CapturePath "*"]

Constructors

Path

Fields

• unPath :: [PathItem]

Instances

IsString Path

Defined in Mig.Core.Api

Methods

fromString :: String -> Path

Monoid Path

Defined in Mig.Core.Api

Methods

mempty :: Path

mappend :: Path -> Path -> Path

mconcat :: [Path] -> Path

Semigroup Path

Defined in Mig.Core.Api

Methods

(<>) :: Path -> Path -> Path

sconcat :: NonEmpty Path -> Path

stimes :: Integral b => b -> Path -> Path

Show Path

Defined in Mig.Core.Api

Methods

showsPrec :: Int -> Path -> ShowS

show :: Path -> String

showList :: [Path] -> ShowS

Eq Path

Defined in Mig.Core.Api

Methods

(==) :: Path -> Path -> Bool

(/=) :: Path -> Path -> Bool

Ord Path

Defined in Mig.Core.Api

Methods

compare :: Path -> Path -> Ordering

(<) :: Path -> Path -> Bool

(<=) :: Path -> Path -> Bool

(>) :: Path -> Path -> Bool

(>=) :: Path -> Path -> Bool

max :: Path -> Path -> Path

min :: Path -> Path -> Path

ToHttpApiData Path

Defined in Mig.Core.Api

Methods

toUrlPiece :: Path -> Text

toEncodedUrlPiece :: Path -> Builder

toHeader :: Path -> ByteString

toQueryParam :: Path -> Text

toEncodedQueryParam :: Path -> Builder

newtype ApiNormal a

Efficient representation of API to fetch routes

Constructors

ApiNormal (MethodMap (OutputMediaMap (InputMediaMap a)))

Instances

Functor ApiNormal

Defined in Mig.Core.Api

Methods

fmap :: (a -> b) -> ApiNormal a -> ApiNormal b

(<$) :: a -> ApiNormal b -> ApiNormal a

Show a => Show (ApiNormal a)

Defined in Mig.Core.Api

Methods

showsPrec :: Int -> ApiNormal a -> ShowS

show :: ApiNormal a -> String

showList :: [ApiNormal a] -> ShowS

Eq a => Eq (ApiNormal a)

Defined in Mig.Core.Api

Methods

(==) :: ApiNormal a -> ApiNormal a -> Bool

(/=) :: ApiNormal a -> ApiNormal a -> Bool

toNormalApi :: forall m. Api (Route m) -> ApiNormal (Api (Route m))

converts API to efficient representation to fetch the route handlers by path

fromNormalApi :: Method -> ByteString -> ByteString -> ApiNormal a -> Maybe a

Read sub-api by HTTP method, accept-type and content-type

data PathItem

Path can be a static item or capture with a name

Constructors

StaticPath Text

CapturePath Text

Instances

Show PathItem

Defined in Mig.Core.Api

Methods

showsPrec :: Int -> PathItem -> ShowS

show :: PathItem -> String

showList :: [PathItem] -> ShowS

Eq PathItem

Defined in Mig.Core.Api

Methods

(==) :: PathItem -> PathItem -> Bool

(/=) :: PathItem -> PathItem -> Bool

Ord PathItem

Defined in Mig.Core.Api

Methods

compare :: PathItem -> PathItem -> Ordering

(<) :: PathItem -> PathItem -> Bool

(<=) :: PathItem -> PathItem -> Bool

(>) :: PathItem -> PathItem -> Bool

(>=) :: PathItem -> PathItem -> Bool

max :: PathItem -> PathItem -> PathItem

min :: PathItem -> PathItem -> PathItem

ToHttpApiData PathItem

Defined in Mig.Core.Api

Methods

toUrlPiece :: PathItem -> Text

toEncodedUrlPiece :: PathItem -> Builder

toHeader :: PathItem -> ByteString

toQueryParam :: PathItem -> Text

toEncodedQueryParam :: PathItem -> Builder

getPath :: [Text] -> Api a -> Maybe (a, CaptureMap)

Find an api item by path. Also it accumulates capture map along the way.

type CaptureMap = Map Text Text

Map of capture values extracted from path. Keys are capture names.

flatApi :: Api a -> [(Path, a)]

Flattens API. Creates a flat list of paths and route handlers.

fromFlatApi :: [(Path, a)] -> Api a

Constructs API from flat list of pairs of paths and route handlers.

type MethodMap a = Map Method a

Mthod map

newtype OutputMediaMap a

filter by Accept header

Constructors

OutputMediaMap (MediaMap a)

Instances

Functor OutputMediaMap

Defined in Mig.Core.Api

Methods

fmap :: (a -> b) -> OutputMediaMap a -> OutputMediaMap b

(<$) :: a -> OutputMediaMap b -> OutputMediaMap a

Show a => Show (OutputMediaMap a)

Defined in Mig.Core.Api

Methods

showsPrec :: Int -> OutputMediaMap a -> ShowS

show :: OutputMediaMap a -> String

showList :: [OutputMediaMap a] -> ShowS

Eq a => Eq (OutputMediaMap a)

Defined in Mig.Core.Api

Methods

(==) :: OutputMediaMap a -> OutputMediaMap a -> Bool

(/=) :: OutputMediaMap a -> OutputMediaMap a -> Bool

newtype InputMediaMap a

filter by Content-Type header

Constructors

InputMediaMap (MediaMap a)

Instances

Functor InputMediaMap

Defined in Mig.Core.Api

Methods

fmap :: (a -> b) -> InputMediaMap a -> InputMediaMap b

(<$) :: a -> InputMediaMap b -> InputMediaMap a

Show a => Show (InputMediaMap a)

Defined in Mig.Core.Api

Methods

showsPrec :: Int -> InputMediaMap a -> ShowS

show :: InputMediaMap a -> String

showList :: [InputMediaMap a] -> ShowS

Eq a => Eq (InputMediaMap a)

Defined in Mig.Core.Api

Methods

(==) :: InputMediaMap a -> InputMediaMap a -> Bool

(/=) :: InputMediaMap a -> InputMediaMap a -> Bool

data MediaMap a

Map by media type

Constructors

MediaMap

Fields

• mapValues :: [(MediaType, a)]
• matchAll :: a

Instances

Functor MediaMap

Defined in Mig.Core.Api

Methods

fmap :: (a -> b) -> MediaMap a -> MediaMap b

(<$) :: a -> MediaMap b -> MediaMap a

Show a => Show (MediaMap a)

Defined in Mig.Core.Api

Methods

showsPrec :: Int -> MediaMap a -> ShowS

show :: MediaMap a -> String

showList :: [MediaMap a] -> ShowS

Eq a => Eq (MediaMap a)

Defined in Mig.Core.Api

Methods

(==) :: MediaMap a -> MediaMap a -> Bool

(/=) :: MediaMap a -> MediaMap a -> Bool