Servant.Docs.Simple.Parse

Parse Servant API into documentation

Example script

Generating the intermediate documentation structure

Parsing custom API type combinators

Example of parsing an API

API type

type API = "hello" :> "world" :> Request :> Response
type Request = ReqBody '[()] ()
type Response = Post '[()] ()

Intermediate structure

ApiDocs ( fromList [( "/hello/world",
                    , Details (fromList ([ ( "RequestBody"
                                           , Details (fromList ([ ( "Format"
                                                                  , Detail "': * () ('[] *)"
                                                                  )
                                                                , ( "ContentType"
                                                                  , Detail "()"
                                                                  )
                                                                ]))
                                           )
                                         , ( "RequestType"
                                           , Detail "'POST"
                                           )
                                         , ( "Response"
                                           , Details (fromList ([ ( "Format"
                                                                  , Detail "': * () ('[] *)"
                                                                  )
                                                                , ( "ContentType"
                                                                  , Detail "()"
                                                                  )
                                                                ]))
                                           )
                                         ]))
                    )])

Documentation

class HasDocumentApi api where

Folds an api endpoint into documentation

Methods

document

Arguments

:: Route

Route documentation

-> [(Parameter, Details)]

Everything else documentation

-> (Route, OMap Parameter Details)

Generated documentation for the route

We use this to destructure the API type and convert it into documentation

Instances

(HasDocumentApi b, Typeable ct, Typeable typ) => HasDocumentApi (StreamBody' m ct typ :> b :: Type)

Stream body documentation

Defined in Servant.Docs.Simple.Parse

Methods

document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)

HasDocumentApi b => HasDocumentApi (HttpVersion :> b :: Type)

Request HttpVersion documentation

Defined in Servant.Docs.Simple.Parse

Methods

document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)

(HasDocumentApi b, Typeable ct, Typeable typ) => HasDocumentApi (ReqBody' m ct typ :> b :: Type)

Request body documentation

Defined in Servant.Docs.Simple.Parse

Methods

document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)

HasDocumentApi b => HasDocumentApi (RemoteHost :> b :: Type)

Request Remote host documentation

Defined in Servant.Docs.Simple.Parse

Methods

document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)

(HasDocumentApi b, KnownSymbol param, Typeable typ) => HasDocumentApi (QueryParam' m param typ :> b :: Type)

Query param documentation

Defined in Servant.Docs.Simple.Parse

Methods

document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)

(HasDocumentApi b, KnownSymbol param, Typeable typ) => HasDocumentApi (QueryParams param typ :> b :: Type)

Query params documentation

Defined in Servant.Docs.Simple.Parse

Methods

document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)

(HasDocumentApi b, KnownSymbol param) => HasDocumentApi (QueryFlag param :> b :: Type)

Query flag documentation

Defined in Servant.Docs.Simple.Parse

Methods

document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)

(HasDocumentApi b, KnownSymbol ct, Typeable typ) => HasDocumentApi (Header' m ct typ :> b :: Type)

Request header documentation

Defined in Servant.Docs.Simple.Parse

Methods

document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)

HasDocumentApi b => HasDocumentApi (IsSecure :> b :: Type)

IsSecure documentation

Defined in Servant.Docs.Simple.Parse

Methods

document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)

(HasDocumentApi b, KnownSymbol token) => HasDocumentApi (AuthProtect token :> b :: Type)

Authentication documentation

Defined in Servant.Docs.Simple.Parse

Methods

document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)

(HasDocumentApi b, KnownSymbol s) => HasDocumentApi (Summary s :> b :: Type)

Summary documentation

Defined in Servant.Docs.Simple.Parse

Methods

document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)

(HasDocumentApi b, KnownSymbol desc) => HasDocumentApi (Description desc :> b :: Type)

Description documentation

Defined in Servant.Docs.Simple.Parse

Methods

document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)

(HasDocumentApi b, KnownSymbol dRoute, Typeable t) => HasDocumentApi (Capture' m dRoute t :> b :: Type)

Capture documentation

Defined in Servant.Docs.Simple.Parse

Methods

document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)

(HasDocumentApi b, KnownSymbol dRoute, Typeable t) => HasDocumentApi (CaptureAll dRoute t :> b :: Type)

CaptureAll documentation

Defined in Servant.Docs.Simple.Parse

Methods

document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)

(HasDocumentApi b, KnownSymbol realm, Typeable a) => HasDocumentApi (BasicAuth realm a :> b :: Type)

Basic authentication documentation

Defined in Servant.Docs.Simple.Parse

Methods

document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)

HasDocumentApi b => HasDocumentApi (Vault :> b :: Type)

Vault documentation

Defined in Servant.Docs.Simple.Parse

Methods

document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)

(HasDocumentApi b, KnownSymbol route) => HasDocumentApi (route :> b :: Type)

Static route documentation

Defined in Servant.Docs.Simple.Parse

Methods

document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)

(Typeable m, Typeable ct, Typeable typ) => HasDocumentApi (Verb m s ct typ :: Type)

Response documentation Terminates here as responses are last parts of api endpoints Note that request type information (GET, POST etc...) is contained here

Defined in Servant.Docs.Simple.Parse

Methods

document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)

class HasParsable api where

Flattens API into type level list of Endpoints

Methods

parse :: ApiDocs

Instances

HasCollatable (Endpoints a) => HasParsable (a :: Type)

If the flattened API can be collated into documentation, it is parsable

Defined in Servant.Docs.Simple.Parse

Methods

parse :: ApiDocs

HasParsable EmptyAPI

Empty APIs should have no documentation

Defined in Servant.Docs.Simple.Parse

Methods

parse :: ApiDocs

symbolVal' :: forall n. KnownSymbol n => Text

Convert symbol to Text

toDetails :: [(Text, Details)] -> Details

Convert parameter-value pairs to Details type

typeText :: forall a. Typeable a => Text

Convert types to Text