| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Servant.Docs
Contents
Description
This module lets you get API docs for free. It lets you generate
an API from the type that represents your API using docs:
docs ::HasDocsapi =>Proxyapi ->API
Alternatively, if you wish to add one or more introductions to your
documentation, use docsWithIntros:
docsWithIntros::HasDocsapi => [DocIntro] ->Proxyapi ->API
You can then call markdown on the API value:
markdown::API-> String
or define a custom pretty printer:
yourPrettyDocs :: API -> String -- or blaze-html's HTML, or ...The only thing you'll need to do will be to implement some classes for your captures, get parameters and request or response bodies.
See example/greet.hs for an example.
- class HasDocs api where
- docs :: HasDocs api => Proxy api -> API
- pretty :: Proxy api -> Proxy (Pretty api)
- markdown :: API -> String
- docsWith :: HasDocs api => DocOptions -> [DocIntro] -> ExtraInfo api -> Proxy api -> API
- docsWithIntros :: HasDocs api => [DocIntro] -> Proxy api -> API
- docsWithOptions :: HasDocs api => Proxy api -> DocOptions -> API
- newtype ExtraInfo api = ExtraInfo (HashMap Endpoint Action)
- extraInfo :: (IsIn endpoint api, HasLink endpoint, HasDocs endpoint) => Proxy endpoint -> Action -> ExtraInfo api
- data DocOptions = DocOptions {
- _maxSamples :: Int
- defaultDocOptions :: DocOptions
- maxSamples :: Iso' DocOptions Int
- class ToSample a where
- toSample :: forall a. ToSample a => Proxy a -> Maybe a
- noSamples :: [(Text, a)]
- singleSample :: a -> [(Text, a)]
- samples :: [a] -> [(Text, a)]
- sampleByteString :: forall ct cts a. (ToSample a, AllMimeRender (ct ': cts) a) => Proxy (ct ': cts) -> Proxy a -> [(MediaType, ByteString)]
- sampleByteStrings :: forall ct cts a. (ToSample a, AllMimeRender (ct ': cts) a) => Proxy (ct ': cts) -> Proxy a -> [(Text, MediaType, ByteString)]
- class ToParam t where
- class ToCapture c where
- data Endpoint
- path :: Lens' Endpoint [String]
- method :: Lens' Endpoint Method
- defEndpoint :: Endpoint
- data API
- apiIntros :: Lens' API [DocIntro]
- apiEndpoints :: Lens' API (HashMap Endpoint Action)
- emptyAPI :: API
- data DocCapture = DocCapture {
- _capSymbol :: String
- _capDesc :: String
- capSymbol :: Lens' DocCapture String
- capDesc :: Lens' DocCapture String
- data DocQueryParam = DocQueryParam {
- _paramName :: String
- _paramValues :: [String]
- _paramDesc :: String
- _paramKind :: ParamKind
- data ParamKind
- paramName :: Lens' DocQueryParam String
- paramValues :: Lens' DocQueryParam [String]
- paramDesc :: Lens' DocQueryParam String
- paramKind :: Lens' DocQueryParam ParamKind
- data DocNote = DocNote {
- _noteTitle :: String
- _noteBody :: [String]
- noteTitle :: Lens' DocNote String
- noteBody :: Lens' DocNote [String]
- data DocIntro = DocIntro {
- _introTitle :: String
- _introBody :: [String]
- introTitle :: Lens' DocIntro String
- introBody :: Lens' DocIntro [String]
- data Response = Response {
- _respStatus :: Int
- _respTypes :: [MediaType]
- _respBody :: [(Text, MediaType, ByteString)]
- _respHeaders :: [Header]
- respStatus :: Lens' Response Int
- respTypes :: Lens' Response [MediaType]
- respBody :: Lens' Response [(Text, MediaType, ByteString)]
- defResponse :: Response
- data Action
- captures :: Lens' Action [DocCapture]
- headers :: Lens' Action [Text]
- notes :: Lens' Action [DocNote]
- params :: Lens' Action [DocQueryParam]
- rqtypes :: Lens' Action [MediaType]
- rqbody :: Lens' Action [(Text, MediaType, ByteString)]
- response :: Lens' Action Response
- defAction :: Action
- single :: Endpoint -> Action -> API
HasDocs class and key functions
class HasDocs api where Source #
The class that abstracts away the impact of API combinators on documentation generation.
Minimal complete definition
Instances
| HasDocs * EmptyAPI Source # | The generated docs for |
| HasDocs * Raw Source # | |
| (HasDocs * a, HasDocs * b) => HasDocs * ((:<|>) a b) Source # | The generated docs for |
| HasDocs * api => HasDocs * (WithNamedContext name context api) Source # | |
| (ToAuthInfo * (BasicAuth realm usr), HasDocs k api) => HasDocs * ((:>) k * (BasicAuth realm usr) api) Source # | |
| HasDocs k api => HasDocs * ((:>) k * Vault api) Source # | |
| HasDocs k api => HasDocs * ((:>) k * HttpVersion api) Source # | |
| HasDocs k api => HasDocs * ((:>) k * IsSecure api) Source # | |
| HasDocs k api => HasDocs * ((:>) k * RemoteHost api) Source # | |
| (KnownSymbol path, HasDocs k api) => HasDocs * ((:>) k Symbol path api) Source # | |
| (ToSample a, AllMimeRender ((:) * ct cts) a, HasDocs k api) => HasDocs * ((:>) k * (ReqBody * ((:) * ct cts) a) api) Source # | |
| (KnownSymbol sym, ToParam * (QueryFlag sym), HasDocs k api) => HasDocs * ((:>) k * (QueryFlag sym) api) Source # | |
| (KnownSymbol sym, ToParam * (QueryParams k1 sym a), HasDocs k api) => HasDocs * ((:>) k * (QueryParams k1 sym a) api) Source # | |
| (KnownSymbol sym, ToParam * (QueryParam k1 sym a), HasDocs k api) => HasDocs * ((:>) k * (QueryParam k1 sym a) api) Source # | |
| (KnownSymbol sym, HasDocs k api) => HasDocs * ((:>) k * (Header sym a) api) Source # | |
| (KnownSymbol sym, ToCapture * (CaptureAll k1 sym a), HasDocs k sublayout) => HasDocs * ((:>) k * (CaptureAll k1 sym a) sublayout) Source # |
|
| (KnownSymbol sym, ToCapture * (Capture k1 sym a), HasDocs k api) => HasDocs * ((:>) k * (Capture k1 sym a) api) Source # |
|
| (ToSample a, AllMimeRender ((:) * ct cts) a, KnownNat status, ReflectMethod k1 method, AllHeaderSamples [*] ls, GetHeaders (HList ls)) => HasDocs * (Verb * k1 method status ((:) * ct cts) (Headers ls a)) Source # | |
| (ToSample a, AllMimeRender ((:) * ct cts) a, KnownNat status, ReflectMethod k1 method) => HasDocs * (Verb * k1 method status ((:) * ct cts) a) Source # | |
docs :: HasDocs api => Proxy api -> API Source #
Generate the docs for a given API that implements HasDocs. This is the
default way to create documentation.
docs == docsWithOptions defaultDocOptions
Generating docs with extra information
docsWith :: HasDocs api => DocOptions -> [DocIntro] -> ExtraInfo api -> Proxy api -> API Source #
Generate documentation given some extra introductions (in the form of
DocInfo) and some extra endpoint documentation (in the form of
ExtraInfo.
The extra introductions will be prepended to the top of the documentation, before the specific endpoint documentation. The extra endpoint documentation will be "unioned" with the automatically generated endpoint documentation.
You are expected to build up the ExtraInfo with the Monoid instance and
extraInfo.
If you only want to add an introduction, use docsWithIntros.
docsWithIntros :: HasDocs api => [DocIntro] -> Proxy api -> API Source #
Generate the docs for a given API that implements HasDocs with with any
number of introduction(s)
docsWithOptions :: HasDocs api => Proxy api -> DocOptions -> API Source #
Generate the docs for a given API that implements HasDocs.
newtype ExtraInfo api Source #
Type of extra information that a user may wish to "union" with their documentation.
These are intended to be built using extraInfo. Multiple ExtraInfo may be combined with the monoid instance.
extraInfo :: (IsIn endpoint api, HasLink endpoint, HasDocs endpoint) => Proxy endpoint -> Action -> ExtraInfo api Source #
Create an ExtraInfo that is guaranteed to be within the given API layout.
The safety here is to ensure that you only add custom documentation to an endpoint that actually exists within your API.
extra :: ExtraInfo TestApi
extra =
extraInfo (Proxy :: Proxy ("greet" :> Capture "greetid" Text :> Delete)) $
defAction & headers <>~ ["unicorns"]
& notes <>~ [ DocNote "Title" ["This is some text"]
, DocNote "Second secton" ["And some more"]
]data DocOptions Source #
Documentation options.
Constructors
| DocOptions | |
Fields
| |
Instances
defaultDocOptions :: DocOptions Source #
Default documentation options.
Classes you need to implement for your types
class ToSample a where Source #
The class that lets us display a sample input or output in the supported content-types when generating documentation for endpoints that either:
- expect a request body, or
- return a non empty response body
Example of an instance:
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE OverloadedStrings #-}
import Data.Aeson
import Data.Text
import GHC.Generics
data Greet = Greet { _msg :: Text }
deriving (Generic, Show)
instance FromJSON Greet
instance ToJSON Greet
instance ToSample Greet where
toSamples _ = singleSample g
where g = Greet "Hello, haskeller!"You can also instantiate this class using toSamples instead of
toSample: it lets you specify different responses along with
some context (as Text) that explains when you're supposed to
get the corresponding response.
Methods
toSamples :: Proxy a -> [(Text, a)] Source #
toSamples :: (Generic a, GToSample (Rep a)) => Proxy a -> [(Text, a)] Source #
Instances
toSample :: forall a. ToSample a => Proxy a -> Maybe a Source #
Sample input or output (if there is at least one).
singleSample :: a -> [(Text, a)] Source #
Single sample without description.
sampleByteString :: forall ct cts a. (ToSample a, AllMimeRender (ct ': cts) a) => Proxy (ct ': cts) -> Proxy a -> [(MediaType, ByteString)] Source #
Synthesise a sample value of a type, encoded in the specified media types.
sampleByteStrings :: forall ct cts a. (ToSample a, AllMimeRender (ct ': cts) a) => Proxy (ct ': cts) -> Proxy a -> [(Text, MediaType, ByteString)] Source #
Synthesise a list of sample values of a particular type, encoded in the specified media types.
class ToParam t where Source #
The class that helps us automatically get documentation for GET parameters.
Example of an instance:
instance ToParam (QueryParam "capital" Bool) where
toParam _ =
DocQueryParam "capital"
["true", "false"]
"Get the greeting message in uppercase (true) or not (false). Default is false."Minimal complete definition
Methods
toParam :: Proxy t -> DocQueryParam Source #
class ToCapture c where Source #
The class that helps us automatically get documentation for URL captures.
Example of an instance:
instance ToCapture (Capture "name" Text) where toCapture _ = DocCapture "name" "name of the person to greet"
Minimal complete definition
Methods
toCapture :: Proxy c -> DocCapture Source #
ADTs to represent an API
An Endpoint type that holds the path and the method.
Gets used as the key in the API hashmap. Modify defEndpoint
or any Endpoint value you want using the path and method
lenses to tweak.
λ>defEndpointGET / λ>defEndpoint&path<>~["foo"] GET /foo λ>defEndpoint&path<>~["foo"] &method.~methodPostPOST /foo
defEndpoint :: Endpoint Source #
An Endpoint whose path is `"/"` and whose method is GET
Here's how you can modify it:
λ>defEndpointGET / λ>defEndpoint&path<>~["foo"] GET /foo λ>defEndpoint&path<>~["foo"] &method.~methodPostPOST /foo
data DocCapture Source #
A type to represent captures. Holds the name of the capture and a description.
Write a ToCapture instance for your captured types.
Constructors
| DocCapture | |
Fields
| |
Instances
data DocQueryParam Source #
A type to represent a GET parameter from the Query String. Holds its name, the possible values (leave empty if there isn't a finite number of them), and a description of how it influences the output or behavior.
Write a ToParam instance for your GET parameter types
Constructors
| DocQueryParam | |
Fields
| |
Instances
Type of GET parameter:
- Normal corresponds to
QueryParam, i.e your usual GET parameter - List corresponds to
QueryParams, i.e GET parameters with multiple values - Flag corresponds to
QueryFlag, i.e a value-less GET parameter
A type to represent extra notes that may be attached to an Action.
This is intended to be used when writing your own HasDocs instances to add extra sections to your endpoint's documentation.
Constructors
| DocNote | |
Fields
| |
An introductory paragraph for your documentation. You can pass these to
docsWithIntros.
Constructors
| DocIntro | |
Fields
| |
A type to represent an HTTP response. Has an Int status, a list of
possible MediaTypes, and a list of example ByteString response bodies.
Tweak defResponse using the respStatus, respTypes and respBody
lenses if you want.
If you want to respond with a non-empty response body, you'll most likely
want to write a ToSample instance for the type that'll be represented
as encoded data in the response.
Can be tweaked with three lenses.
λ> defResponse
Response {_respStatus = 200, _respTypes = [], _respBody = []}
λ> defResponse & respStatus .~ 204 & respBody .~ [("If everything goes well", "{ \"status\": \"ok\" }")]
Response {_respStatus = 204, _respTypes = [], _respBody = [("If everything goes well", "{ \"status\": \"ok\" }")]}Constructors
| Response | |
Fields
| |
defResponse :: Response Source #
Default response: status code 200, no response body.
Can be tweaked with two lenses.
λ> defResponse
Response {_respStatus = 200, _respBody = Nothing}
λ> defResponse & respStatus .~ 204 & respBody .~ Just "[]"
Response {_respStatus = 204, _respBody = Just "[]"}A datatype that represents everything that can happen at an endpoint, with its lenses:
- List of captures (
captures) - List of GET parameters (
params) - What the request body should look like, if any is requested (
rqbody) - What the response should be if everything goes well (
response)
You can tweak an Action (like the default defAction) with these lenses
to transform an action and add some information to it.