module Servant.Docs.Simple ( document
, documentWith
, stdoutJson
, stdoutMarkdown
, stdoutPlainText
, writeDocsJson
, writeDocsMarkdown
, writeDocsPlainText
) where
import Data.Aeson.Encode.Pretty (encodePretty)
import qualified Data.ByteString.Lazy as B (writeFile)
import qualified Data.ByteString.Lazy.Char8 as BC (putStrLn)
import qualified Data.Text.IO as T (putStrLn, writeFile)
import Servant.Docs.Simple.Parse (HasParsableApi (..))
import Servant.Docs.Simple.Render (Json (..), Markdown (..), PlainText (..), Renderable (..))
writeDocsPlainText :: forall api. HasParsableApi api => FilePath -> IO ()
writeDocsPlainText :: FilePath -> IO ()
writeDocsPlainText FilePath
fp = FilePath -> Text -> IO ()
T.writeFile FilePath
fp (Text -> IO ()) -> (PlainText -> Text) -> PlainText -> IO ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. PlainText -> Text
getPlainText (PlainText -> IO ()) -> PlainText -> IO ()
forall a b. (a -> b) -> a -> b
$ HasParsableApi api => PlainText
forall k (api :: k). HasParsableApi api => PlainText
document @api
writeDocsMarkdown :: forall api. HasParsableApi api => FilePath -> IO ()
writeDocsMarkdown :: FilePath -> IO ()
writeDocsMarkdown FilePath
fp = FilePath -> Text -> IO ()
T.writeFile FilePath
fp (Text -> IO ()) -> (Markdown -> Text) -> Markdown -> IO ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Markdown -> Text
getMarkdown (Markdown -> IO ()) -> Markdown -> IO ()
forall a b. (a -> b) -> a -> b
$ (HasParsableApi api, Renderable Markdown) => Markdown
forall k (api :: k) a. (HasParsableApi api, Renderable a) => a
documentWith @api @Markdown
writeDocsJson :: forall api. HasParsableApi api => FilePath -> IO ()
writeDocsJson :: FilePath -> IO ()
writeDocsJson FilePath
fp = FilePath -> ByteString -> IO ()
B.writeFile FilePath
fp (ByteString -> IO ()) -> (Json -> ByteString) -> Json -> IO ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Value -> ByteString
forall a. ToJSON a => a -> ByteString
encodePretty (Value -> ByteString) -> (Json -> Value) -> Json -> ByteString
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Json -> Value
getJson (Json -> IO ()) -> Json -> IO ()
forall a b. (a -> b) -> a -> b
$ (HasParsableApi api, Renderable Json) => Json
forall k (api :: k) a. (HasParsableApi api, Renderable a) => a
documentWith @api @Json
stdoutPlainText :: forall api. HasParsableApi api => IO ()
stdoutPlainText :: IO ()
stdoutPlainText = Text -> IO ()
T.putStrLn (Text -> IO ()) -> (PlainText -> Text) -> PlainText -> IO ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. PlainText -> Text
getPlainText (PlainText -> IO ()) -> PlainText -> IO ()
forall a b. (a -> b) -> a -> b
$ HasParsableApi api => PlainText
forall k (api :: k). HasParsableApi api => PlainText
document @api
stdoutMarkdown :: forall api. HasParsableApi api => IO ()
stdoutMarkdown :: IO ()
stdoutMarkdown = Text -> IO ()
T.putStrLn (Text -> IO ()) -> (Markdown -> Text) -> Markdown -> IO ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Markdown -> Text
getMarkdown (Markdown -> IO ()) -> Markdown -> IO ()
forall a b. (a -> b) -> a -> b
$ (HasParsableApi api, Renderable Markdown) => Markdown
forall k (api :: k) a. (HasParsableApi api, Renderable a) => a
documentWith @api @Markdown
stdoutJson :: forall api. HasParsableApi api => IO ()
stdoutJson :: IO ()
stdoutJson = ByteString -> IO ()
BC.putStrLn (ByteString -> IO ()) -> (Json -> ByteString) -> Json -> IO ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Value -> ByteString
forall a. ToJSON a => a -> ByteString
encodePretty (Value -> ByteString) -> (Json -> Value) -> Json -> ByteString
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Json -> Value
getJson (Json -> IO ()) -> Json -> IO ()
forall a b. (a -> b) -> a -> b
$ (HasParsableApi api, Renderable Json) => Json
forall k (api :: k) a. (HasParsableApi api, Renderable a) => a
documentWith @api @Json
document :: forall api. HasParsableApi api => PlainText
document :: PlainText
document = (HasParsableApi api, Renderable PlainText) => PlainText
forall k (api :: k) a. (HasParsableApi api, Renderable a) => a
documentWith @api @PlainText
documentWith :: forall api a. (HasParsableApi api, Renderable a) => a
documentWith :: a
documentWith = ApiDocs -> a
forall a. Renderable a => ApiDocs -> a
render @a (HasParsableApi api => ApiDocs
forall k (api :: k). HasParsableApi api => ApiDocs
parseApi @api)