Safe Haskell	None
Language	Haskell2010

Servant.Swagger.UI.Core

Contents

Swagger UI API
Implementation details

Synopsis

type SwaggerSchemaUI (dir :: Symbol ) (schema :: Symbol ) = SwaggerSchemaUI' dir (schema :> Get '[ JSON ] Value )
type SwaggerSchemaUI' (dir :: Symbol ) (api :: *) = api :<|> (dir :> ( Get '[ HTML ] ( SwaggerUiHtml dir api) :<|> (("index.html" :> Get '[ HTML ] ( SwaggerUiHtml dir api)) :<|> Raw )))
data SwaggerUiHtml (dir :: Symbol ) (api :: *) = SwaggerUiHtml Text
swaggerSchemaUIServerImpl :: ( Monad m, ServerT api m ~ m Value , ToJSON a) => Text -> [( FilePath , ByteString )] -> a -> ServerT ( SwaggerSchemaUI' dir api) m
swaggerSchemaUIServerImpl' :: Monad m => Text -> [( FilePath , ByteString )] -> ServerT api m -> ServerT ( SwaggerSchemaUI' dir api) m
data Handler a

Swagger UI API

type SwaggerSchemaUI (dir :: Symbol ) (schema :: Symbol ) = SwaggerSchemaUI' dir (schema :> Get '[ JSON ] Value ) Source #

Swagger schema + ui api.

SwaggerSchemaUI "swagger-ui" "swagger.json" will result into following hierarchy:

/swagger.json
/swagger-ui
/swagger-ui/index.html
/swagger-ui/...

This type does not actually force served type to be Swagger from swagger2 package, it could be arbitrary aeson Value .

type SwaggerSchemaUI' (dir :: Symbol ) (api :: *) = api :<|> (dir :> ( Get '[ HTML ] ( SwaggerUiHtml dir api) :<|> (("index.html" :> Get '[ HTML ] ( SwaggerUiHtml dir api)) :<|> Raw ))) Source #

Use SwaggerSchemaUI' when you need even more control over where swagger.json is served (e.g. subdirectory).

Implementation details

data SwaggerUiHtml (dir :: Symbol ) (api :: *) Source #

Index file for swagger ui.

It's configured by the location of swagger schema and directory it lives under.

Implementation detail: the index.html is prepopulated with parameters to find schema file automatically.

Constructors

SwaggerUiHtml Text

Instances

Instances details

( KnownSymbol dir, HasLink api, Link ~ MkLink api Link , IsElem api api) => ToMarkup ( SwaggerUiHtml dir api) Source #
Instance details Defined in Servant.Swagger.UI.Core Methods toMarkup :: SwaggerUiHtml dir api -> Markup Source # preEscapedToMarkup :: SwaggerUiHtml dir api -> Markup Source #

swaggerSchemaUIServerImpl :: ( Monad m, ServerT api m ~ m Value , ToJSON a) => Text -> [( FilePath , ByteString )] -> a -> ServerT ( SwaggerSchemaUI' dir api) m Source #

swaggerSchemaUIServerImpl' :: Monad m => Text -> [( FilePath , ByteString )] -> ServerT api m -> ServerT ( SwaggerSchemaUI' dir api) m Source #

Use a custom server to serve the Swagger spec source.

data Handler a Source #

Instances

Instances details

Monad Handler
Instance details Defined in Servant.Server.Internal.Handler Methods (>>=) :: Handler a -> (a -> Handler b) -> Handler b Source # (>>) :: Handler a -> Handler b -> Handler b Source # return :: a -> Handler a Source #
Functor Handler
Instance details Defined in Servant.Server.Internal.Handler Methods fmap :: (a -> b) -> Handler a -> Handler b Source # (<$) :: a -> Handler b -> Handler a Source #
MonadFail Handler
Instance details Defined in Servant.Server.Internal.Handler Methods fail :: String -> Handler a Source #
Applicative Handler
Instance details Defined in Servant.Server.Internal.Handler Methods pure :: a -> Handler a Source # (<>) :: Handler (a -> b) -> Handler a -> Handler b Source # liftA2 :: (a -> b -> c) -> Handler a -> Handler b -> Handler c Source # (>) :: Handler a -> Handler b -> Handler b Source # (<*) :: Handler a -> Handler b -> Handler a Source #
MonadIO Handler
Instance details Defined in Servant.Server.Internal.Handler Methods liftIO :: IO a -> Handler a Source #
MonadThrow Handler
Instance details Defined in Servant.Server.Internal.Handler Methods throwM :: Exception e => e -> Handler a Source #
MonadCatch Handler
Instance details Defined in Servant.Server.Internal.Handler Methods catch :: Exception e => Handler a -> (e -> Handler a) -> Handler a Source #
MonadMask Handler
Instance details Defined in Servant.Server.Internal.Handler Methods mask :: (( forall a. Handler a -> Handler a) -> Handler b) -> Handler b Source # uninterruptibleMask :: (( forall a. Handler a -> Handler a) -> Handler b) -> Handler b Source # generalBracket :: Handler a -> (a -> ExitCase b -> Handler c) -> (a -> Handler b) -> Handler (b, c) Source #
MonadBase IO Handler
Instance details Defined in Servant.Server.Internal.Handler Methods liftBase :: IO α -> Handler α Source #
MonadBaseControl IO Handler
Instance details Defined in Servant.Server.Internal.Handler Associated Types type StM Handler a Source # Methods liftBaseWith :: ( RunInBase Handler IO -> IO a) -> Handler a Source # restoreM :: StM Handler a -> Handler a Source #
MonadError ServerError Handler
Instance details Defined in Servant.Server.Internal.Handler Methods throwError :: ServerError -> Handler a Source # catchError :: Handler a -> ( ServerError -> Handler a) -> Handler a Source #
Generic ( Handler a)
Instance details Defined in Servant.Server.Internal.Handler Associated Types type Rep ( Handler a) :: Type -> Type Source # Methods from :: Handler a -> Rep ( Handler a) x Source # to :: Rep ( Handler a) x -> Handler a Source #
type StM Handler a
Instance details Defined in Servant.Server.Internal.Handler type StM Handler a = Either ServerError a
type Rep ( Handler a)
Instance details Defined in Servant.Server.Internal.Handler type Rep ( Handler a) = D1 (' MetaData "Handler" "Servant.Server.Internal.Handler" "servant-server-0.19.2-G0Z4CBXVk6K3TywlQVHRKg" ' True ) ( C1 (' MetaCons "Handler" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "runHandler'") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( ExceptT ServerError IO a))))