git.iko.soy/typeable/servant
on master help sign in
Add docs for serving an EmptyAPI
commit62560079b1bd275c53c3b1a79c433da9b4c8c33d authorDavid Turner <dave.c.turner@gmail.com> dateTue 16 May 2017, 11:09 (9 years ago) parent178f055
1 file changed+8
servant-server/src/Servant/Server/Internal.hs+8
servant-server/src/Servant/Server/Internal.hs+8
@@ -532,11 +532,19 @@ instance HasServer api context => HasServer (HttpVersion :> api) context where
532532 route Proxy context subserver =
533533 route (Proxy :: Proxy api) context (passToServer subserver httpVersion)
534534
535+-- | Singleton type representing a server that serves an empty API
535536data EmptyAPIServer = EmptyAPIServer
536537
538+-- | Server for `EmptyAPI`
537539emptyAPIServer :: Server EmptyAPI
538540emptyAPIServer = Tagged EmptyAPIServer
539541
542+-- | The server for an `EmptyAPI` is `emptyAPIServer`.
543+--
544+-- > type MyApi = "nothing" :> EmptyApi
545+-- >
546+-- > server :: Server MyApi
547+-- > server = emptyAPIServer
540548instance HasServer EmptyAPI context where
541549 type ServerT EmptyAPI m = Tagged m EmptyAPIServer
542550