| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Servant.Docs.Simple
Description
Documentation for API endpoints
Synopsis
- document :: forall api. HasParsable api => PlainText
- documentWith :: forall api a. (HasParsable api, Renderable a) => a
- stdoutJson :: forall api. HasParsable api => IO ()
- stdoutPlainText :: forall api. HasParsable api => IO ()
- writeDocsJson :: forall api. HasParsable api => FilePath -> IO ()
- writeDocsPlainText :: forall api. HasParsable api => FilePath -> IO ()
Documentation
document :: forall api. HasParsable api => PlainText Source #
Convert API type into PlainText format
documentWith :: forall api a. (HasParsable api, Renderable a) => a Source #
Convert API type into specified formats
stdoutJson :: forall api. HasParsable api => IO () Source #
Write documentation as JSON to stdout
stdoutPlainText :: forall api. HasParsable api => IO () Source #
Write documentation as PlainText to stdout
writeDocsJson :: forall api. HasParsable api => FilePath -> IO () Source #
Write documentation as JSON to file
writeDocsPlainText :: forall api. HasParsable api => FilePath -> IO () Source #
Write documentation as PlainText to file