Safe Haskell	None
Language	Haskell2010

Servant.Elm

Contents

Convenience re-exports from the Elm module
Convenience re-exports from Data.Proxy

Description

Basic usage:

import MyLib (MyServantApiType)
import Servant.Elm

spec :: Spec
spec = Spec ["Generated", "MyApi"]
            (defElmImports : generateElmForAPI (Proxy :: Proxy MyServantApiType))

main :: IO ()
main = specsToDir [spec] "my-elm-dir"

Synopsis

generateElmForAPI :: (HasForeign LangElm ElmDatatype api, GenerateList ElmDatatype (Foreign ElmDatatype api)) => Proxy api -> [Text]
generateElmForAPIWith :: (HasForeign LangElm ElmDatatype api, GenerateList ElmDatatype (Foreign ElmDatatype api)) => ElmOptions -> Proxy api -> [Text]
data ElmOptions = ElmOptions {
- urlPrefix :: UrlPrefix
- elmExportOptions :: Options
- emptyResponseElmTypes :: [ElmDatatype]
- stringElmTypes :: [ElmDatatype]
}
data UrlPrefix
- = Static Text
- | Dynamic
defElmOptions :: ElmOptions
defElmImports :: Text
data Spec = Spec [Text] [Text]
class ElmType a
specsToDir :: [Spec] -> FilePath -> IO ()
data Proxy (t :: k) :: forall k. k -> Type = Proxy

Documentation

generateElmForAPI :: (HasForeign LangElm ElmDatatype api, GenerateList ElmDatatype (Foreign ElmDatatype api)) => Proxy api -> [Text] #

Generate Elm code for the API with default options.

Returns a list of Elm functions to query your Servant API from Elm.

You could spit these out to a file and call them from your Elm code, but you would be better off creating a Spec with the result and using specsToDir, which handles the module name for you.

generateElmForAPIWith :: (HasForeign LangElm ElmDatatype api, GenerateList ElmDatatype (Foreign ElmDatatype api)) => ElmOptions -> Proxy api -> [Text] #

Generate Elm code for the API with custom options.

data ElmOptions #

Options to configure how code is generated.

Constructors

ElmOptions

Fields

urlPrefix :: UrlPrefix
The protocol, host and any path prefix to be used as the base for all requests.
Example: Static "https://mydomain.com/api/v1"
When Dynamic, the generated Elm functions take the base URL as the first argument.
elmExportOptions :: Options
Options to pass to elm-export
emptyResponseElmTypes :: [ElmDatatype]
Types that represent an empty Http response.
stringElmTypes :: [ElmDatatype]
Types that represent a String.

data UrlPrefix #

Constructors

Static Text
Dynamic

defElmOptions :: ElmOptions #

Default options for generating Elm code.

The default options are:

{ urlPrefix =
    Static ""
, elmExportOptions =
    Elm.defaultOptions
, emptyResponseElmTypes =
    [ toElmType NoContent ]
, stringElmTypes =
    [ toElmType "" ]
}

defElmImports :: Text #

Default imports required by generated Elm code.

You probably want to include this at the top of your generated Elm module.

The default required imports are:

import Json.Decode exposing (..)
import Json.Decode.Pipeline exposing (..)
import Json.Encode
import Http
import String

Convenience re-exports from the Elm module

data Spec #

Constructors

Spec [Text] [Text]

class ElmType a #

Instances

ElmType Bool
Instance details Defined in Elm.Type Methods toElmType :: Bool -> ElmDatatype #
ElmType Char
Instance details Defined in Elm.Type Methods toElmType :: Char -> ElmDatatype #
ElmType Double
Instance details Defined in Elm.Type Methods toElmType :: Double -> ElmDatatype #
ElmType Float
Instance details Defined in Elm.Type Methods toElmType :: Float -> ElmDatatype #
ElmType Int
Instance details Defined in Elm.Type Methods toElmType :: Int -> ElmDatatype #
ElmType Int8
Instance details Defined in Elm.Type Methods toElmType :: Int8 -> ElmDatatype #
ElmType Int16
Instance details Defined in Elm.Type Methods toElmType :: Int16 -> ElmDatatype #
ElmType Int32
Instance details Defined in Elm.Type Methods toElmType :: Int32 -> ElmDatatype #
ElmType Int64
Instance details Defined in Elm.Type Methods toElmType :: Int64 -> ElmDatatype #
ElmType ()
Instance details Defined in Elm.Type Methods toElmType :: () -> ElmDatatype #
ElmType Text
Instance details Defined in Elm.Type Methods toElmType :: Text -> ElmDatatype #
ElmType UTCTime
Instance details Defined in Elm.Type Methods toElmType :: UTCTime -> ElmDatatype #
ElmType ElmDatatype #
Instance details Defined in Servant.Elm.Internal.Orphans Methods toElmType :: ElmDatatype -> ElmDatatype #
ElmType NoContent #
Instance details Defined in Servant.Elm.Internal.Orphans Methods toElmType :: NoContent -> ElmDatatype #
ElmType Day
Instance details Defined in Elm.Type Methods toElmType :: Day -> ElmDatatype #
ElmType a => ElmType [a]
Instance details Defined in Elm.Type Methods toElmType :: [a] -> ElmDatatype #
ElmType a => ElmType (Maybe a)
Instance details Defined in Elm.Type Methods toElmType :: Maybe a -> ElmDatatype #
ElmType v => ElmType (IntMap v)
Instance details Defined in Elm.Type Methods toElmType :: IntMap v -> ElmDatatype #
(ElmType a, ElmType b) => ElmType (a, b)
Instance details Defined in Elm.Type Methods toElmType :: (a, b) -> ElmDatatype #
(HasElmComparable k, ElmType v) => ElmType (Map k v)
Instance details Defined in Elm.Type Methods toElmType :: Map k v -> ElmDatatype #
ElmType a => ElmType (Proxy a)
Instance details Defined in Elm.Type Methods toElmType :: Proxy a -> ElmDatatype #
ElmType a => ElmType (Headers ls a) #
Instance details Defined in Servant.Elm.Internal.Orphans Methods toElmType :: Headers ls a -> ElmDatatype #

specsToDir :: [Spec] -> FilePath -> IO () #

Convenience re-exports from Data.Proxy

data Proxy (t :: k) :: forall k. k -> Type #

Proxy is a type that holds no data, but has a phantom parameter of arbitrary type (or even kind). Its use is to provide type information, even though there is no value available of that type (or it may be too costly to create one).

Historically, Proxy :: Proxy a is a safer alternative to the 'undefined :: a' idiom.

>>> Proxy :: Proxy (Void, Int -> Int)
Proxy

Proxy can even hold types of higher kinds,

>>> Proxy :: Proxy Either
Proxy

>>> Proxy :: Proxy Functor
Proxy

>>> Proxy :: Proxy complicatedStructure
Proxy

Constructors

Proxy

Instances

Generic1 (Proxy :: k -> Type)
Instance details Defined in GHC.Generics Associated Types type Rep1 Proxy :: k -> Type # Methods from1 :: Proxy a -> Rep1 Proxy a # to1 :: Rep1 Proxy a -> Proxy a #
Monad (Proxy :: Type -> Type)	Since: base-4.7.0.0
Instance details Defined in Data.Proxy Methods (>>=) :: Proxy a -> (a -> Proxy b) -> Proxy b # (>>) :: Proxy a -> Proxy b -> Proxy b # return :: a -> Proxy a # fail :: String -> Proxy a #
Functor (Proxy :: Type -> Type)	Since: base-4.7.0.0
Instance details Defined in Data.Proxy Methods fmap :: (a -> b) -> Proxy a -> Proxy b # (<$) :: a -> Proxy b -> Proxy a #
Applicative (Proxy :: Type -> Type)	Since: base-4.7.0.0
Instance details Defined in Data.Proxy Methods pure :: a -> Proxy a # (<>) :: Proxy (a -> b) -> Proxy a -> Proxy b # liftA2 :: (a -> b -> c) -> Proxy a -> Proxy b -> Proxy c # (>) :: Proxy a -> Proxy b -> Proxy b # (<*) :: Proxy a -> Proxy b -> Proxy a #
Foldable (Proxy :: Type -> Type)	Since: base-4.7.0.0
Instance details Defined in Data.Foldable Methods fold :: Monoid m => Proxy m -> m # foldMap :: Monoid m => (a -> m) -> Proxy a -> m # foldr :: (a -> b -> b) -> b -> Proxy a -> b # foldr' :: (a -> b -> b) -> b -> Proxy a -> b # foldl :: (b -> a -> b) -> b -> Proxy a -> b # foldl' :: (b -> a -> b) -> b -> Proxy a -> b # foldr1 :: (a -> a -> a) -> Proxy a -> a # foldl1 :: (a -> a -> a) -> Proxy a -> a # toList :: Proxy a -> [a] # null :: Proxy a -> Bool # length :: Proxy a -> Int # elem :: Eq a => a -> Proxy a -> Bool # maximum :: Ord a => Proxy a -> a # minimum :: Ord a => Proxy a -> a # sum :: Num a => Proxy a -> a # product :: Num a => Proxy a -> a #
Traversable (Proxy :: Type -> Type)	Since: base-4.7.0.0
Instance details Defined in Data.Traversable Methods traverse :: Applicative f => (a -> f b) -> Proxy a -> f (Proxy b) # sequenceA :: Applicative f => Proxy (f a) -> f (Proxy a) # mapM :: Monad m => (a -> m b) -> Proxy a -> m (Proxy b) # sequence :: Monad m => Proxy (m a) -> m (Proxy a) #
Contravariant (Proxy :: Type -> Type)
Instance details Defined in Data.Functor.Contravariant Methods contramap :: (a -> b) -> Proxy b -> Proxy a # (>$) :: b -> Proxy b -> Proxy a #
Representable (Proxy :: Type -> Type)
Instance details Defined in Data.Functor.Rep Associated Types type Rep Proxy :: Type # Methods tabulate :: (Rep Proxy -> a) -> Proxy a # index :: Proxy a -> Rep Proxy -> a #
Alternative (Proxy :: Type -> Type)	Since: base-4.9.0.0
Instance details Defined in Data.Proxy Methods empty :: Proxy a # (<\|>) :: Proxy a -> Proxy a -> Proxy a # some :: Proxy a -> Proxy [a] # many :: Proxy a -> Proxy [a] #
MonadPlus (Proxy :: Type -> Type)	Since: base-4.9.0.0
Instance details Defined in Data.Proxy Methods mzero :: Proxy a # mplus :: Proxy a -> Proxy a -> Proxy a #
Hashable1 (Proxy :: Type -> Type)
Instance details Defined in Data.Hashable.Class Methods liftHashWithSalt :: (Int -> a -> Int) -> Int -> Proxy a -> Int #
Bounded (Proxy t)	Since: base-4.7.0.0
Instance details Defined in Data.Proxy Methods minBound :: Proxy t # maxBound :: Proxy t #
Enum (Proxy s)	Since: base-4.7.0.0
Instance details Defined in Data.Proxy Methods succ :: Proxy s -> Proxy s # pred :: Proxy s -> Proxy s # toEnum :: Int -> Proxy s # fromEnum :: Proxy s -> Int # enumFrom :: Proxy s -> [Proxy s] # enumFromThen :: Proxy s -> Proxy s -> [Proxy s] # enumFromTo :: Proxy s -> Proxy s -> [Proxy s] # enumFromThenTo :: Proxy s -> Proxy s -> Proxy s -> [Proxy s] #
Eq (Proxy s)	Since: base-4.7.0.0
Instance details Defined in Data.Proxy Methods (==) :: Proxy s -> Proxy s -> Bool # (/=) :: Proxy s -> Proxy s -> Bool #
Ord (Proxy s)	Since: base-4.7.0.0
Instance details Defined in Data.Proxy Methods compare :: Proxy s -> Proxy s -> Ordering # (<) :: Proxy s -> Proxy s -> Bool # (<=) :: Proxy s -> Proxy s -> Bool # (>) :: Proxy s -> Proxy s -> Bool # (>=) :: Proxy s -> Proxy s -> Bool # max :: Proxy s -> Proxy s -> Proxy s # min :: Proxy s -> Proxy s -> Proxy s #
Read (Proxy t)	Since: base-4.7.0.0
Instance details Defined in Data.Proxy Methods readsPrec :: Int -> ReadS (Proxy t) # readList :: ReadS [Proxy t] # readPrec :: ReadPrec (Proxy t) # readListPrec :: ReadPrec [Proxy t] #
Show (Proxy s)	Since: base-4.7.0.0
Instance details Defined in Data.Proxy Methods showsPrec :: Int -> Proxy s -> ShowS # show :: Proxy s -> String # showList :: [Proxy s] -> ShowS #
Ix (Proxy s)	Since: base-4.7.0.0
Instance details Defined in Data.Proxy Methods range :: (Proxy s, Proxy s) -> [Proxy s] # index :: (Proxy s, Proxy s) -> Proxy s -> Int # unsafeIndex :: (Proxy s, Proxy s) -> Proxy s -> Int inRange :: (Proxy s, Proxy s) -> Proxy s -> Bool # rangeSize :: (Proxy s, Proxy s) -> Int # unsafeRangeSize :: (Proxy s, Proxy s) -> Int
Generic (Proxy t)
Instance details Defined in GHC.Generics Associated Types type Rep (Proxy t) :: Type -> Type # Methods from :: Proxy t -> Rep (Proxy t) x # to :: Rep (Proxy t) x -> Proxy t #
Semigroup (Proxy s)	Since: base-4.9.0.0
Instance details Defined in Data.Proxy Methods (<>) :: Proxy s -> Proxy s -> Proxy s # sconcat :: NonEmpty (Proxy s) -> Proxy s # stimes :: Integral b => b -> Proxy s -> Proxy s #
Monoid (Proxy s)	Since: base-4.7.0.0
Instance details Defined in Data.Proxy Methods mempty :: Proxy s # mappend :: Proxy s -> Proxy s -> Proxy s # mconcat :: [Proxy s] -> Proxy s #
Hashable (Proxy a)
Instance details Defined in Data.Hashable.Class Methods hashWithSalt :: Int -> Proxy a -> Int # hash :: Proxy a -> Int #
ElmType a => ElmType (Proxy a)
Instance details Defined in Elm.Type Methods toElmType :: Proxy a -> ElmDatatype #
type Rep1 (Proxy :: k -> Type)	Since: base-4.6.0.0
Instance details Defined in GHC.Generics type Rep1 (Proxy :: k -> Type) = D1 (MetaData "Proxy" "Data.Proxy" "base" False) (C1 (MetaCons "Proxy" PrefixI False) (U1 :: k -> Type))
type Rep (Proxy :: Type -> Type)
Instance details Defined in Data.Functor.Rep type Rep (Proxy :: Type -> Type) = Void
type Rep (Proxy t)	Since: base-4.6.0.0
Instance details Defined in GHC.Generics type Rep (Proxy t) = D1 (MetaData "Proxy" "Data.Proxy" "base" False) (C1 (MetaCons "Proxy" PrefixI False) (U1 :: Type -> Type))