apiary-2.0.1: Simple and type safe web framework that generate web API documentation.

Safe HaskellNone
LanguageHaskell2010

Data.Apiary.Document

Synopsis

Documentation

data Documents Source

Constructors

Documents 

Fields

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

data Route Source

Constructors

Path Text Route 
Fetch Text TypeRep (Maybe Html) Route 
Rest Text (Maybe Html)

** with name

Any

** without name

End 

Instances

data PathDoc Source

Constructors

PathDoc 

Fields

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

data MethodDoc Source

Constructors

MethodDoc 

Fields

queries :: [QueryDoc]
 
preconditions :: [Html]
 
accept :: Maybe ByteString
 
document :: Text
 

data QueryDoc Source

query parameters document

Constructors

QueryDoc 

Fields

queryName :: Text
 
queryStrategy :: StrategyRep
 
queryRep :: QueryRep
 
queryDocument :: Maybe Html