eeva/servant
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add instance HasDocs EmptyAPI

Browse source
This commit is contained in:
David Turner 2017-05-16 09:52:55 +00:00
parent a87067a6c1
commit 2cfa71891b
2 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/tutorial/Docs.lhs
View file

@ -38,9 +38,10 @@ Like client function generation, documentation generation amounts to inspecting
This time however, we have to assist **servant**. While it is able to deduce a lot of things about our API, it can't magically come up with descriptions of the various pieces of our APIs that are human-friendly and explain what's going on "at the business-logic level". A good example to study for documentation generation is our webservice with the `/position`, `/hello` and `/marketing` endpoints from earlier: This time however, we have to assist **servant**. While it is able to deduce a lot of things about our API, it can't magically come up with descriptions of the various pieces of our APIs that are human-friendly and explain what's going on "at the business-logic level". A good example to study for documentation generation is our webservice with the `/position`, `/hello` and `/marketing` endpoints from earlier:
``` haskell ``` haskell
type ExampleAPI = "position" :> Capture "x" Int :> Capture "y" Int :> Get '[JSON] Position type ExampleAPI = ("position" :> Capture "x" Int :> Capture "y" Int :> Get '[JSON] Position
:<|> "hello" :> QueryParam "name" String :> Get '[JSON] HelloMessage :<|> "hello" :> QueryParam "name" String :> Get '[JSON] HelloMessage
:<|> "marketing" :> ReqBody '[JSON] ClientInfo :> Post '[JSON] Email :<|> "marketing" :> ReqBody '[JSON] ClientInfo :> Post '[JSON] Email)
:<|> EmptyAPI
exampleAPI :: Proxy ExampleAPI exampleAPI :: Proxy ExampleAPI
exampleAPI = Proxy exampleAPI = Proxy
@ -220,7 +221,7 @@ api :: Proxy DocsAPI
api = Proxy api = Proxy
server :: Server DocsAPI server :: Server DocsAPI
server = Server.server3 :<|> Tagged serveDocs where server = (Server.server3 :<|> emptyAPIServer) :<|> Tagged serveDocs where
serveDocs _ respond = serveDocs _ respond =
respond $ responseLBS ok200 [plain] docsBS respond $ responseLBS ok200 [plain] docsBS
plain = ("Content-Type", "text/plain") plain = ("Content-Type", "text/plain")

4
servant-docs/src/Servant/Docs/Internal.hs
View file

@ -683,6 +683,10 @@ instance OVERLAPPABLE_
p2 :: Proxy b p2 :: Proxy b
p2 = Proxy p2 = Proxy
-- | The generated docs for @'EmptyAPI'@ are empty.
instance HasDocs EmptyAPI where
docsFor Proxy _ _ = emptyAPI
-- | @"books" :> 'Capture' "isbn" Text@ will appear as -- | @"books" :> 'Capture' "isbn" Text@ will appear as
-- @/books/:isbn@ in the docs. -- @/books/:isbn@ in the docs.
instance (KnownSymbol sym, ToCapture (Capture sym a), HasDocs api) instance (KnownSymbol sym, ToCapture (Capture sym a), HasDocs api)