apiary-0.13.0: Simple and type safe web framework that can be automatically generate API documentation.

Safe HaskellNone

Data.Apiary.Document

Synopsis

Documentation

data StrategyRep Source

Constructors

StrategyRep 

Fields

strategyInfo :: Text
 

Instances

data Doc Source

Constructors

DocPath Text Doc 
DocRoot Doc 
DocFetch TypeRep (Maybe Html) Doc 
DocMethod Method Doc 
DocQuery ByteString StrategyRep QueryRep Html Doc 
DocGroup Text Doc 
DocPrecondition Html Doc 
Document (Maybe Text) 

data Route Source

Constructors

Path Text Route 
Fetch TypeRep (Maybe Html) Route 
End 

Instances

data Documents Source

Constructors

Documents 

Fields

noGroup :: [PathDoc]
 
groups :: [(Text, [PathDoc])]
 

data PathDoc Source

Constructors

PathDoc 

Fields

path :: Route
 
methods :: [(Method, [MethodDoc])]
 

data QueryDoc Source

Constructors

QueryDoc 

Fields

queryName :: ByteString
 
queryStrategy :: StrategyRep
 
queryRep :: QueryRep
 
queryDocument :: Html
 

data MethodDoc Source

Constructors

MethodDoc 

Fields

queries :: [QueryDoc]
 
preconditions :: [Html]
 
document :: Text
 

docToDocument :: Doc -> Maybe (Maybe Text, PathDoc)Source

mergePathDoc :: [PathDoc] -> [PathDoc]Source

mergeMethods :: [(Method, [MethodDoc])] -> [(Method, [MethodDoc])]Source

docsToDocuments :: [Doc] -> DocumentsSource

routeToHtml :: Route -> (Text, Html, Html)Source

data DefaultDocumentConfig Source

Constructors

DefaultDocumentConfig 

Fields

documentTitle :: Text
 
documentDescription :: Maybe Html
 
documentUseCDN :: Bool
 

Instances

defaultDocumentToHtml :: DefaultDocumentConfig -> Documents -> HtmlSource

rpHtml :: Html -> Int -> HtmlSource

construct Html as route parameter. since 0.13.0.