Safe Haskell	Safe-Inferred
Language	GHC2021

Mig.Swagger

Contents

utils

Synopsis

data SwaggerConfig m = SwaggerConfig {
- staticDir :: Path
- swaggerFile :: Path
- mapSchema :: OpenApi -> m OpenApi
}
withSwagger :: MonadIO m => SwaggerConfig m -> Server m -> Server m
swagger :: forall m. MonadIO m => SwaggerConfig m -> m OpenApi -> Server m
class Default a where
- def :: a
data DefaultInfo = DefaultInfo {
- title :: Text
- description :: Text
- version :: Text
}
addDefaultInfo :: DefaultInfo -> OpenApi -> OpenApi
writeOpenApi :: FilePath -> Server m -> IO ()
printOpenApi :: Server m -> IO ()

Documentation

data SwaggerConfig m Source #

Swagger config

Constructors

SwaggerConfig
Fields staticDir :: Path path to server swagger (default is "/swagger-ui") swaggerFile :: Path swagger file name (default is "swaggger.json") mapSchema :: OpenApi -> m OpenApi apply transformation to OpenApi schema on serving OpenApi schema. it is useful to add additional info or set current date in the examples or apply any real-time transformation.

Instances

Instances details

Applicative m => Default (SwaggerConfig m) Source #
Instance details Defined in Mig.Swagger Methods def :: SwaggerConfig m #

withSwagger :: MonadIO m => SwaggerConfig m -> Server m -> Server m Source #

Appends swagger UI to server

swagger :: forall m. MonadIO m => SwaggerConfig m -> m OpenApi -> Server m Source #

Swagger server. It serves static files and injects OpenApi schema

utils

class Default a where #

A class for types with a default value.

Minimal complete definition

Nothing

Methods

def :: a #

The default value for this type.

Instances

Instances details

Default All
Instance details Defined in Data.Default.Class Methods def :: All #
Default Any
Instance details Defined in Data.Default.Class Methods def :: Any #
Default CClock
Instance details Defined in Data.Default.Class Methods def :: CClock #
Default CDouble
Instance details Defined in Data.Default.Class Methods def :: CDouble #
Default CFloat
Instance details Defined in Data.Default.Class Methods def :: CFloat #
Default CInt
Instance details Defined in Data.Default.Class Methods def :: CInt #
Default CIntMax
Instance details Defined in Data.Default.Class Methods def :: CIntMax #
Default CIntPtr
Instance details Defined in Data.Default.Class Methods def :: CIntPtr #
Default CLLong
Instance details Defined in Data.Default.Class Methods def :: CLLong #
Default CLong
Instance details Defined in Data.Default.Class Methods def :: CLong #
Default CPtrdiff
Instance details Defined in Data.Default.Class Methods def :: CPtrdiff #
Default CSUSeconds
Instance details Defined in Data.Default.Class Methods def :: CSUSeconds #
Default CShort
Instance details Defined in Data.Default.Class Methods def :: CShort #
Default CSigAtomic
Instance details Defined in Data.Default.Class Methods def :: CSigAtomic #
Default CSize
Instance details Defined in Data.Default.Class Methods def :: CSize #
Default CTime
Instance details Defined in Data.Default.Class Methods def :: CTime #
Default CUInt
Instance details Defined in Data.Default.Class Methods def :: CUInt #
Default CUIntMax
Instance details Defined in Data.Default.Class Methods def :: CUIntMax #
Default CUIntPtr
Instance details Defined in Data.Default.Class Methods def :: CUIntPtr #
Default CULLong
Instance details Defined in Data.Default.Class Methods def :: CULLong #
Default CULong
Instance details Defined in Data.Default.Class Methods def :: CULong #
Default CUSeconds
Instance details Defined in Data.Default.Class Methods def :: CUSeconds #
Default CUShort
Instance details Defined in Data.Default.Class Methods def :: CUShort #
Default Int16
Instance details Defined in Data.Default.Class Methods def :: Int16 #
Default Int32
Instance details Defined in Data.Default.Class Methods def :: Int32 #
Default Int64
Instance details Defined in Data.Default.Class Methods def :: Int64 #
Default Int8
Instance details Defined in Data.Default.Class Methods def :: Int8 #
Default Word16
Instance details Defined in Data.Default.Class Methods def :: Word16 #
Default Word32
Instance details Defined in Data.Default.Class Methods def :: Word32 #
Default Word64
Instance details Defined in Data.Default.Class Methods def :: Word64 #
Default Word8
Instance details Defined in Data.Default.Class Methods def :: Word8 #
Default SetCookie	`def` = `defaultSetCookie`
Instance details Defined in Web.Cookie Methods def :: SetCookie #
Default Ordering
Instance details Defined in Data.Default.Class Methods def :: Ordering #
Default DefaultInfo Source #
Instance details Defined in Mig.Swagger Methods def :: DefaultInfo #
Default Integer
Instance details Defined in Data.Default.Class Methods def :: Integer #
Default ()
Instance details Defined in Data.Default.Class Methods def :: () #
Default Double
Instance details Defined in Data.Default.Class Methods def :: Double #
Default Float
Instance details Defined in Data.Default.Class Methods def :: Float #
Default Int
Instance details Defined in Data.Default.Class Methods def :: Int #
Default Word
Instance details Defined in Data.Default.Class Methods def :: Word #
(Default a, RealFloat a) => Default (Complex a)
Instance details Defined in Data.Default.Class Methods def :: Complex a #
Default (First a)
Instance details Defined in Data.Default.Class Methods def :: First a #
Default (Last a)
Instance details Defined in Data.Default.Class Methods def :: Last a #
Default a => Default (Dual a)
Instance details Defined in Data.Default.Class Methods def :: Dual a #
Default (Endo a)
Instance details Defined in Data.Default.Class Methods def :: Endo a #
Num a => Default (Product a)
Instance details Defined in Data.Default.Class Methods def :: Product a #
Num a => Default (Sum a)
Instance details Defined in Data.Default.Class Methods def :: Sum a #
Integral a => Default (Ratio a)
Instance details Defined in Data.Default.Class Methods def :: Ratio a #
Default a => Default (IO a)
Instance details Defined in Data.Default.Class Methods def :: IO a #
Applicative m => Default (SwaggerConfig m) Source #
Instance details Defined in Mig.Swagger Methods def :: SwaggerConfig m #
Default (Maybe a)
Instance details Defined in Data.Default.Class Methods def :: Maybe a #
Default [a]
Instance details Defined in Data.Default.Class Methods def :: [a] #
Default r => Default (e -> r)
Instance details Defined in Data.Default.Class Methods def :: e -> r #
(Default a, Default b) => Default (a, b)
Instance details Defined in Data.Default.Class Methods def :: (a, b) #
(Default a, Default b, Default c) => Default (a, b, c)
Instance details Defined in Data.Default.Class Methods def :: (a, b, c) #
(Default a, Default b, Default c, Default d) => Default (a, b, c, d)
Instance details Defined in Data.Default.Class Methods def :: (a, b, c, d) #
(Default a, Default b, Default c, Default d, Default e) => Default (a, b, c, d, e)
Instance details Defined in Data.Default.Class Methods def :: (a, b, c, d, e) #
(Default a, Default b, Default c, Default d, Default e, Default f) => Default (a, b, c, d, e, f)
Instance details Defined in Data.Default.Class Methods def :: (a, b, c, d, e, f) #
(Default a, Default b, Default c, Default d, Default e, Default f, Default g) => Default (a, b, c, d, e, f, g)
Instance details Defined in Data.Default.Class Methods def :: (a, b, c, d, e, f, g) #

data DefaultInfo Source #

Default info that is often added to OpenApi schema

Constructors

DefaultInfo
Fields title :: Text description :: Text version :: Text

Instances

Instances details

Default DefaultInfo Source #
Instance details Defined in Mig.Swagger Methods def :: DefaultInfo #

addDefaultInfo :: DefaultInfo -> OpenApi -> OpenApi Source #

Adds most common used info to OpenApi schema. Use this function in the mapSchema field of the SwaggerConfig.

writeOpenApi :: FilePath -> Server m -> IO () Source #

Writes openapi schema to file

printOpenApi :: Server m -> IO () Source #

Prints openapi schema file to stdout