Servant.Docs.Simple.Parse

Parse Servant API into documentation

Example script

Generating the intermediate documentation structure

Example of parsing an API

API type

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

Intermediate structure

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

Documentation

class HasParsable api where

Flattens API into type level list of Endpoints

Methods

parse :: Endpoints

Instances

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

Defined in Servant.Docs.Simple.Parse

Methods

parse :: Endpoints

HasParsable EmptyAPI

Defined in Servant.Docs.Simple.Parse

Methods

parse :: Endpoints