Safe Haskell	None
Language	Haskell2010

Servant.Docs.Simple.Render

Description

Provides an Intermediate documentation structure (Endpoints), and renderable formats (Renderable)

Synopsis

data Details
- = Details [Node]
- | Detail Text
newtype Endpoints = Endpoints [Node]
data Node = Node Text Details
class Renderable a where
- render :: Endpoints -> a
newtype Json = Json {
- getJson :: Value
}
newtype Pretty ann = Pretty {
- getPretty :: Doc ann
}
newtype PlainText = PlainText {
- getPlainText :: Text
}

Documentation

data Details Source #

Value representation; see Endpoints and Node documentation for a clearer picture

Constructors

Details [Node]	List of Parameter-Value pairs
Detail Text	Single Value

Instances

Eq Details Source #
Instance details Defined in Servant.Docs.Simple.Render Methods (==) :: Details -> Details -> Bool # (/=) :: Details -> Details -> Bool #
Show Details Source #
Instance details Defined in Servant.Docs.Simple.Render Methods showsPrec :: Int -> Details -> ShowS # show :: Details -> String # showList :: [Details] -> ShowS #
ToJSON Details Source #
Instance details Defined in Servant.Docs.Simple.Render Methods toJSON :: Details -> Value # toEncoding :: Details -> Encoding # toJSONList :: [Details] -> Value # toEncodingList :: [Details] -> Encoding #

newtype Endpoints Source #

Intermediate documentation structure, a linked-list of endpoints (Nodes)

API type:

  type API = "users" :> (      "update" :> Response '[()] ()
                          :<|> "get"    :> Response '[()] ()
                        )

Parsed into Endpoints:

  Endpoints [ Node "/users/update"
                   (Details [ Node "Response"
                                   (Details [ Node "Format" (Detail "': * () ('[] *)")
                                            , Node "ContentType" (Detail "()")
                                            ])
                            ])
            , Node "/users/get"
                   (Details [ Node "Response"
                                   (Details [ Node "Format" (Detail "': * () ('[] *)")
                                            , Node "ContentType" (Detail "()")
                                            ])
                            ])
            ]

For a breakdown reference Node

For more examples reference Test.Servant.Docs.Simple.Samples

Constructors

Endpoints [Node]

Instances

Eq Endpoints Source #
Instance details Defined in Servant.Docs.Simple.Render Methods (==) :: Endpoints -> Endpoints -> Bool # (/=) :: Endpoints -> Endpoints -> Bool #
Show Endpoints Source #
Instance details Defined in Servant.Docs.Simple.Render Methods showsPrec :: Int -> Endpoints -> ShowS # show :: Endpoints -> String # showList :: [Endpoints] -> ShowS #
ToJSON Endpoints Source #
Instance details Defined in Servant.Docs.Simple.Render Methods toJSON :: Endpoints -> Value # toEncoding :: Endpoints -> Encoding # toJSONList :: [Endpoints] -> Value # toEncodingList :: [Endpoints] -> Encoding #

data Node Source #

Key-Value pair for endpoint parameters and their values

Example 1

An endpoint is represented as a node, with the route as its parameter and its Details as its value

Node "/users/get" <Details>

Example 2

Details of each endpoint can also be represented as nodes

Given the following:

Response '[()] ()

This can be interpreted as a Response parameter, with a value of 2 Details, Format and ContentType

In turn, this:

Format: @'[()]@

can be interpreted as a Format parameter with a value of '[()].

And so parsing Response '[()] () comes together as:

Node "Response"                                               --- Parameter
     (Details [ Node "Format"                   -- Parameter  ---
                     (Detail "': * () ('[] *)") -- Value         |
              , Node "ContentType"              -- Parameter     | Value
                     (Detail "()")              -- Value         |
              ])                                              ---

Constructors

Node
Fields Text Parameter name Details Parameter value(s)

Instances

Eq Node Source #
Instance details Defined in Servant.Docs.Simple.Render Methods (==) :: Node -> Node -> Bool # (/=) :: Node -> Node -> Bool #
Show Node Source #
Instance details Defined in Servant.Docs.Simple.Render Methods showsPrec :: Int -> Node -> ShowS # show :: Node -> String # showList :: [Node] -> ShowS #

class Renderable a where Source #

Convert Endpoints into different documentation formats

Methods

render :: Endpoints -> a Source #

Instances

Renderable PlainText Source #
Instance details Defined in Servant.Docs.Simple.Render Methods render :: Endpoints -> PlainText Source #
Renderable Json Source #
Instance details Defined in Servant.Docs.Simple.Render Methods render :: Endpoints -> Json Source #
Renderable (Pretty ann) Source #
Instance details Defined in Servant.Docs.Simple.Render Methods render :: Endpoints -> Pretty ann Source #

newtype Json Source #

Conversion to JSON using Data.Aeson

Constructors

Json
Fields getJson :: Value

Instances

Eq Json Source #
Instance details Defined in Servant.Docs.Simple.Render Methods (==) :: Json -> Json -> Bool # (/=) :: Json -> Json -> Bool #
Show Json Source #
Instance details Defined in Servant.Docs.Simple.Render Methods showsPrec :: Int -> Json -> ShowS # show :: Json -> String # showList :: [Json] -> ShowS #
Renderable Json Source #
Instance details Defined in Servant.Docs.Simple.Render Methods render :: Endpoints -> Json Source #

newtype Pretty ann Source #

Conversion to prettyprint

Constructors

Pretty
Fields getPretty :: Doc ann

Instances

Renderable (Pretty ann) Source #
Instance details Defined in Servant.Docs.Simple.Render Methods render :: Endpoints -> Pretty ann Source #

newtype PlainText Source #

Conversion to plaintext

Constructors

PlainText
Fields getPlainText :: Text

Instances

Eq PlainText Source #
Instance details Defined in Servant.Docs.Simple.Render Methods (==) :: PlainText -> PlainText -> Bool # (/=) :: PlainText -> PlainText -> Bool #
Show PlainText Source #
Instance details Defined in Servant.Docs.Simple.Render Methods showsPrec :: Int -> PlainText -> ShowS # show :: PlainText -> String # showList :: [PlainText] -> ShowS #
Renderable PlainText Source #
Instance details Defined in Servant.Docs.Simple.Render Methods render :: Endpoints -> PlainText Source #