Servant.Docs

HasDocs class and key functions

class HasDocs api

docs

pretty

markdown

Generating docs with extra information

docsWith

docsWithIntros

docsWithOptions

data ExtraInfo api

extraInfo

data DocOptions

defaultDocOptions

maxSamples

Classes you need to implement for your types

class ToSample a

toSample

noSamples

singleSample

samples

sampleByteString

sampleByteStrings

class ToParam t

class ToCapture c

ADTs to represent an API

data Endpoint

path

method

defEndpoint

data API

apiIntros

apiEndpoints

emptyAPI

data DocCapture

capSymbol

capDesc

data DocQueryParam

data ParamKind

paramName

paramValues

paramDesc

paramKind

data DocNote

noteTitle

noteBody

data DocIntro

introTitle

introBody

data Response

respStatus

respTypes

respBody

defResponse

data Action

captures

headers

notes

params

rqtypes

rqbody

response

defAction

single