Merge pull request #58 from haskell-servant/jkarni/remove-serveDocumentation
remove serveDocumentation references/code
This commit is contained in:
commit
09d901d87c
2 changed files with 1 additions and 29 deletions
|
@ -876,30 +876,3 @@ instance (KnownSymbol path, HasDocs sublayout) => HasDocs (path :> sublayout) wh
|
||||||
endpoint' = endpoint & path <>~ [symbolVal pa]
|
endpoint' = endpoint & path <>~ [symbolVal pa]
|
||||||
pa = Proxy :: Proxy path
|
pa = Proxy :: Proxy path
|
||||||
|
|
||||||
{-
|
|
||||||
|
|
||||||
-- | Serve your API's docs as markdown embedded in an html \<pre> tag.
|
|
||||||
--
|
|
||||||
-- > type MyApi = "users" :> Get [User]
|
|
||||||
-- > :<|> "docs :> Raw
|
|
||||||
-- >
|
|
||||||
-- > apiProxy :: Proxy MyApi
|
|
||||||
-- > apiProxy = Proxy
|
|
||||||
-- >
|
|
||||||
-- > server :: Server MyApi
|
|
||||||
-- > server = listUsers
|
|
||||||
-- > :<|> serveDocumentation apiProxy
|
|
||||||
serveDocumentation :: HasDocs api => Proxy api -> Server Raw
|
|
||||||
serveDocumentation proxy _request respond =
|
|
||||||
respond $ responseLBS ok200 [] $ cs $ toHtml $ markdown $ docs proxy
|
|
||||||
|
|
||||||
toHtml :: String -> String
|
|
||||||
toHtml md =
|
|
||||||
"<html>" ++
|
|
||||||
"<body>" ++
|
|
||||||
"<pre>" ++
|
|
||||||
md ++
|
|
||||||
"</pre>" ++
|
|
||||||
"</body>" ++
|
|
||||||
"</html>"
|
|
||||||
-}
|
|
||||||
|
|
|
@ -10,6 +10,5 @@ import Data.Typeable (Typeable)
|
||||||
--
|
--
|
||||||
-- In addition to just letting you plug in your existing WAI 'Application's,
|
-- In addition to just letting you plug in your existing WAI 'Application's,
|
||||||
-- this can also be used with 'Servant.Utils.StaticFiles.serveDirectory' to serve
|
-- this can also be used with 'Servant.Utils.StaticFiles.serveDirectory' to serve
|
||||||
-- static files stored in a particular directory on your filesystem, or to serve
|
-- static files stored in a particular directory on your filesystem
|
||||||
-- your API's documentation with 'Servant.Utils.StaticFiles.serveDocumentation'.
|
|
||||||
data Raw deriving Typeable
|
data Raw deriving Typeable
|
||||||
|
|
Loading…
Reference in a new issue