Servant.Swagger

Contents

• Classes
• Types
• Swaggadelic
• Lenses

Synopsis

• class HasSwagger h where
  • toSwaggerDocs :: Proxy h -> SwaggerRoute -> SwagResult
• class ToSwaggerDescription a where
  • toSwaggerDescription :: Proxy a -> Text
• class ToHeader a where
  • toHeader :: Proxy a -> SwaggerHeader
• class ToSwaggerParamType a where
  • toSwaggerParamType :: Proxy a -> SwaggerParamType
• data SwaggerParamType
  • = StringSwagParam
  • | NumberSwagParam
  • | IntegerSwagParam
  • | BooleanSwagParam
  • | ArraySwagParam
  • | FileSwagParam
• class ToSwaggerModel a where
  • toSwagModel :: Proxy a -> SwaggerModel
  • toSwagModelName :: Proxy a -> ModelName
• class ToHeaderDescription a where
  • toHeaderDescription :: Proxy a -> Text
• class ToModelExample model where
  • toExample :: Proxy model -> Maybe Value
• newtype APIDescription = APIDescription {
  • _unApiDesc :: Text
  }
• data Contact = Contact {
  • _contactName :: ContactName
  • _contactURL :: ContactURL
  • _contactEmail :: ContactEmail
  }
• newtype ContactName = ContactName Text
• newtype ContactURL = ContactURL Text
• newtype ContactEmail = ContactEmail Text
• newtype TermsOfService = TermsOfService Text
• data SwaggerAPI = SwaggerAPI {
  • _swaggerInfo :: Info
  • _swaggerPaths :: HashMap PathName SwaggerOperation
  • _swaggerSchemes :: Maybe [Scheme]
  • _swaggerDefinitions :: HashMap ModelName SwaggerModel
  • _swaggerTags :: Maybe [Tag]
  • _swaggerBasePath :: Maybe BasePath
  • _swaggerHostName :: Maybe HostName
  • _swaggerSecurityDefintions :: Maybe [SecurityDefinition]
  • _swaggerExternalDocs :: Maybe ExternalDocs
  }
• data SwaggerOperation = SwaggerOperation {
  • _paths :: HashMap Verb Operation
  }
• newtype SwaggerRouteInfo a = SwaggerRouteInfo SwagResult
• data Operation = Operation {
  • _summary :: PathSummary
  • _params :: [Param]
  • _responses :: HashMap Code Response
  • _produces :: [ContentType]
  • _consumes :: [ContentType]
  • _tags :: [Tag]
  • _operationId :: Maybe OperationId
  • _description :: PathDescription
  • _deprecated :: Maybe Deprecated
  }
• newtype Code = Code Int
• data Verb
  • = Post
  • | Get
  • | Put
  • | Options
  • | Head
  • | Delete
  • | Patch
• newtype PathSummary = PathSummary Text
• data SwaggerType
  • = IntegerSwag
  • | LongSwag
  • | FloatSwag
  • | DoubleSwag
  • | StringSwag
  • | ByteSwag
  • | BinarySwag
  • | BooleanSwag
  • | DateSwag
  • | DateTimeSwag
  • | PasswordSwag
  • | Model ModelSwag
• data SwaggerModel = SwaggerModel {
  • _swagModelName :: ModelName
  • _swagProperties :: [(Text, SwaggerType)]
  • _swagDescription :: Maybe Description
  • _swagModelExample :: Maybe Value
  • _swagModelRequired :: [Text]
  }
• data Info = Info {
  • _swaggerInfoTitle :: APITitle
  • _swaggerVersion :: APIVersion
  • _swaggerAPIDescription :: APIDescription
  • _license :: Maybe APILicense
  • _contact :: Maybe Contact
  • _termsOfService :: Maybe TermsOfService
  }
• newtype ModelName = ModelName {
  • unModelName :: Text
  }
• data ContentType
  • = JSON
  • | HTML
  • | XML
  • | FormUrlEncoded
  • | PlainText
  • | OctetStream
• newtype APIVersion = APIVersion Text
• newtype APITitle = APITitle Text
• data APILicense = APILicense {
  • _licenseName :: Text
  • _licenseUrl :: Maybe Text
  }
• data Scheme
  • = Http
  • | Https
  • | Ws
  • | Wss
• newtype Description = Description {
  • unDescription :: Text
  }
• newtype BasePath = BasePath Text
• data Response = Response {
  • _responseDescription :: Text
  • _responseModelName :: ModelName
  • _responseHeaders :: HashMap Text SwaggerHeader
  • _responseIsArray :: Bool
  • _responseCode :: Code
  }
• data ModelSwag = ModelSwag {
  • modelSwagName :: ModelName
  • modelSwagIsArray :: Bool
  }
• data SwaggerHeader = SwaggerHeader {
  • headerDescription :: Text
  • headerType :: SwaggerParamType
  • headerName :: Text
  }
• responseDescription :: Lens' Response Text
• responseModelName :: Lens' Response ModelName
• responseHeaders :: Lens' Response (HashMap Text SwaggerHeader)
• responseIsArray :: Lens' Response Bool
• responseCode :: Lens' Response Code
• defResponse :: Response
• data Tag = Tag {
  • _tagName :: TagName
  • _tagDescription :: TagDescription
  }
• newtype TagName = TagName Text
• newtype TagDescription = TagDescription Text
• tagName :: Lens' Tag TagName
• tagDescription :: Lens' Tag TagDescription
• swagger :: HasSwagger swagger => Proxy swagger -> SwaggerRouteInfo swagger -> BasePath -> Info -> [Scheme] -> Maybe HostName -> [SecurityDefinition] -> SwaggerAPI
• emptyModel :: SwaggerModel
• swaggerPathInfo :: (IsElem endpoint layout, HasLink endpoint, HasSwagger endpoint, HasSwagger layout) => Proxy endpoint -> Proxy layout -> SwaggerRouteDescription -> SwaggerRouteInfo layout
• emptyRouteDescription :: SwaggerRouteDescription
• swagModelName :: Lens' SwaggerModel ModelName
• swagModelExample :: Lens' SwaggerModel (Maybe Value)
• swagProperties :: Lens' SwaggerModel [(Text, SwaggerType)]
• swagModelRequired :: Lens' SwaggerModel [Text]
• swagDescription :: Lens' SwaggerModel (Maybe Description)
• swagRouteTags :: Lens' SwaggerRouteDescription [Tag]
• swagRouteSummary :: Lens' SwaggerRouteDescription PathSummary
• swagRouteResponses :: Lens' SwaggerRouteDescription (HashMap Code Response)
• swagRouteModels :: Lens' SwaggerRouteDescription (HashMap ModelName SwaggerModel)
• newtype PathDescription = PathDescription Text
• swagRouteDescription :: Lens' SwaggerRouteDescription PathDescription
• newtype OperationId = OperationId Text
• swagRouteOperationId :: Lens' SwaggerRouteDescription (Maybe OperationId)
• defSwaggerInfo :: Info
• createSwaggerJson :: SwaggerAPI -> IO ()
• swaggerInfoTitle :: Lens' Info APITitle
• swaggerVersion :: Lens' Info APIVersion
• swaggerAPIDescription :: Lens' Info APIDescription
• license :: Lens' Info (Maybe APILicense)
• contact :: Lens' Info (Maybe Contact)
• termsOfService :: Lens' Info (Maybe TermsOfService)

Classes

Types

Swaggadelic

Lenses