Changed the library component's library dependency on 'lens' from

>=0

<4.13

Changed the library component's library dependency on 'servant' from

>=0.2

>=0.2 && <0.2.1

Changed author from

Alp Mestanogullari, Sönke Hahn, Julian K. Arni

Alp Mestanogullari, Sönke Hahn, Julian K. Arni

Changed description from

Library for generating API docs from a servant API definition.

Runnable example below that prints API docs in markdown.

> {-# LANGUAGE DataKinds #-}
> {-# LANGUAGE PolyKinds #-}
> {-# LANGUAGE TypeFamilies #-}
> {-# LANGUAGE DeriveGeneric #-}
> {-# LANGUAGE TypeOperators #-}
> {-# LANGUAGE FlexibleInstances #-}
> {-# LANGUAGE OverloadedStrings #-}
>
> import Data.Proxy
> import Data.Text
> import Servant
>
> -- our type for a Greeting message
> data Greet = Greet { _msg :: Text }
>   deriving (Generic, Show)
>
> -- we get our JSON serialization for free
> instance FromJSON Greet
> instance ToJSON Greet
>
> -- we provide a sample value for the 'Greet' type
> instance ToSample Greet where
>   toSample = Just g
>
>     where g = Greet "Hello, haskeller!"
>
> instance ToParam (QueryParam "capital" Bool) where
>   toParam _ =
>     DocQueryParam "capital"
>                   ["true", "false"]
>                   "Get the greeting message in uppercase (true) or not (false). Default is false."
>
> instance ToCapture (Capture "name" Text) where
>   toCapture _ = DocCapture "name" "name of the person to greet"
>
> instance ToCapture (Capture "greetid" Text) where
>   toCapture _ = DocCapture "greetid" "identifier of the greet msg to remove"
>
> -- API specification
> type TestApi =
>        "hello" :> Capture "name" Text :> QueryParam "capital" Bool :> Get Greet
>   :<|> "greet" :> RQBody Greet :> Post Greet
>   :<|> "delete" :> Capture "greetid" Text :> Delete
>
> testApi :: Proxy TestApi
> testApi = Proxy
>
> -- Generate the Documentation's ADT
> greetDocs :: API
> greetDocs = docs testApi
>
> main :: IO ()
> main = putStrLn $ markdown greetDocs

Library for generating API docs from a servant API definition.

Runnable example <https://github.com/haskell-servant/servant-docs/blob/master/example/greet.hs here> that prints API docs in markdown.