git.iko.soy/servant
on master help sign in
Add docs for serving an EmptyAPI
6256007David Turner
servant-server/src/Servant/Server/Internal.hs+8
compare with master
unifiedsplit
@@ -532,11 +532,19 @@ instance HasServer api context => HasServer (HttpVersion :> api) context where
532 route Proxy context subserver =
532 route Proxy context subserver =
533 route (Proxy :: Proxy api) context (passToServer subserver httpVersion)
533 route (Proxy :: Proxy api) context (passToServer subserver httpVersion)
534
534
535+-- | Singleton type representing a server that serves an empty API
535data EmptyAPIServer = EmptyAPIServer
536data EmptyAPIServer = EmptyAPIServer
536
537
538+-- | Server for `EmptyAPI`
537emptyAPIServer :: Server EmptyAPI
539emptyAPIServer :: Server EmptyAPI
538emptyAPIServer = Tagged EmptyAPIServer
540emptyAPIServer = Tagged EmptyAPIServer
539
541
542+-- | The server for an `EmptyAPI` is `emptyAPIServer`.
543+--
544+-- > type MyApi = "nothing" :> EmptyApi
545+-- >
546+-- > server :: Server MyApi
547+-- > server = emptyAPIServer
540instance HasServer EmptyAPI context where
548instance HasServer EmptyAPI context where
541 type ServerT EmptyAPI m = Tagged m EmptyAPIServer
549 type ServerT EmptyAPI m = Tagged m EmptyAPIServer
542
550