Safe Haskell	None
Language	Haskell2010

Servant.Docs.Simple.Parse

Description

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 "()"
                                                                  )
                                                                ]))
                                           )
                                         ]))
                    )])

Synopsis

class HasDocumentApi api where
- document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details)
class HasParsable api where
- parse :: ApiDocs
symbolVal' :: forall n. KnownSymbol n => Text
toDetails :: [(Text, Details)] -> Details
typeText :: forall a. Typeable a => Text

Documentation

class HasDocumentApi api where Source #

Folds an api endpoint into documentation

Methods

document Source #

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) Source #	Stream body documentation
Instance details Defined in Servant.Docs.Simple.Parse Methods document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details) Source #
HasDocumentApi b => HasDocumentApi (HttpVersion :> b :: Type) Source #	Request HttpVersion documentation
Instance details Defined in Servant.Docs.Simple.Parse Methods document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details) Source #
(HasDocumentApi b, Typeable ct, Typeable typ) => HasDocumentApi (ReqBody' m ct typ :> b :: Type) Source #	Request body documentation
Instance details Defined in Servant.Docs.Simple.Parse Methods document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details) Source #
HasDocumentApi b => HasDocumentApi (RemoteHost :> b :: Type) Source #	Request Remote host documentation
Instance details Defined in Servant.Docs.Simple.Parse Methods document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details) Source #
(HasDocumentApi b, KnownSymbol param, Typeable typ) => HasDocumentApi (QueryParam' m param typ :> b :: Type) Source #	Query param documentation
Instance details Defined in Servant.Docs.Simple.Parse Methods document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details) Source #
(HasDocumentApi b, KnownSymbol param, Typeable typ) => HasDocumentApi (QueryParams param typ :> b :: Type) Source #	Query params documentation
Instance details Defined in Servant.Docs.Simple.Parse Methods document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details) Source #
(HasDocumentApi b, KnownSymbol param) => HasDocumentApi (QueryFlag param :> b :: Type) Source #	Query flag documentation
Instance details Defined in Servant.Docs.Simple.Parse Methods document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details) Source #
(HasDocumentApi b, KnownSymbol ct, Typeable typ) => HasDocumentApi (Header' m ct typ :> b :: Type) Source #	Request header documentation
Instance details Defined in Servant.Docs.Simple.Parse Methods document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details) Source #
HasDocumentApi b => HasDocumentApi (IsSecure :> b :: Type) Source #	IsSecure documentation
Instance details Defined in Servant.Docs.Simple.Parse Methods document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details) Source #
(HasDocumentApi b, KnownSymbol token) => HasDocumentApi (AuthProtect token :> b :: Type) Source #	Authentication documentation
Instance details Defined in Servant.Docs.Simple.Parse Methods document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details) Source #
(HasDocumentApi b, KnownSymbol s) => HasDocumentApi (Summary s :> b :: Type) Source #	Summary documentation
Instance details Defined in Servant.Docs.Simple.Parse Methods document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details) Source #
(HasDocumentApi b, KnownSymbol desc) => HasDocumentApi (Description desc :> b :: Type) Source #	Description documentation
Instance details Defined in Servant.Docs.Simple.Parse Methods document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details) Source #
(HasDocumentApi b, KnownSymbol dRoute, Typeable t) => HasDocumentApi (Capture' m dRoute t :> b :: Type) Source #	Capture documentation
Instance details Defined in Servant.Docs.Simple.Parse Methods document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details) Source #
(HasDocumentApi b, KnownSymbol dRoute, Typeable t) => HasDocumentApi (CaptureAll dRoute t :> b :: Type) Source #	CaptureAll documentation
Instance details Defined in Servant.Docs.Simple.Parse Methods document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details) Source #
(HasDocumentApi b, KnownSymbol realm, Typeable a) => HasDocumentApi (BasicAuth realm a :> b :: Type) Source #	Basic authentication documentation
Instance details Defined in Servant.Docs.Simple.Parse Methods document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details) Source #
HasDocumentApi b => HasDocumentApi (Vault :> b :: Type) Source #	Vault documentation
Instance details Defined in Servant.Docs.Simple.Parse Methods document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details) Source #
(HasDocumentApi b, KnownSymbol route) => HasDocumentApi (route :> b :: Type) Source #	Static route documentation
Instance details Defined in Servant.Docs.Simple.Parse Methods document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details) Source #
(Typeable m, Typeable ct, Typeable typ) => HasDocumentApi (Verb m s ct typ :: Type) Source #	Response documentation Terminates here as responses are last parts of api endpoints Note that request type information (GET, POST etc...) is contained here
Instance details Defined in Servant.Docs.Simple.Parse Methods document :: Route -> [(Parameter, Details)] -> (Route, OMap Parameter Details) Source #

class HasParsable api where Source #

Flattens API into type level list of Endpoints

Methods

parse :: ApiDocs Source #

Instances

HasCollatable (Endpoints a) => HasParsable (a :: Type) Source #	If the flattened API can be collated into documentation, it is parsable
Instance details Defined in Servant.Docs.Simple.Parse Methods parse :: ApiDocs Source #
HasParsable EmptyAPI Source #	Empty APIs should have no documentation
Instance details Defined in Servant.Docs.Simple.Parse Methods parse :: ApiDocs Source #

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

Convert symbol to Text

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

Convert parameter-value pairs to Details type

typeText :: forall a. Typeable a => Text Source #

Convert types to Text