Servant.Docs

HasDocs class and key functions

class HasDocs layout

docs

markdown

Classes you need to implement for your types

class ToSample a

sampleByteString

sampleByteStrings

class ToParam t

class ToCapture c

ADTs to represent an API

data Method

data Endpoint

path

method

defEndpoint

type API

emptyAPI

data DocCapture

capSymbol

capDesc

data DocQueryParam

data ParamKind

paramName

paramValues

paramDesc

paramKind

data Response

respStatus

respBody

defResponse

data Action

captures

headers

params

rqbody

response

defAction

single

Useful modules when defining your doc printers