Merge pull request #82 from haskell-servant/generalize-server-t

Lift restriction of swagger spec delivery from Handler to any Monad

Author: dmjio

servant-swagger-ui-core/src/Servant/Swagger/UI/Core.hs

@@ -101,16 +101,19 @@ instance (KnownSymbol dir, HasLink api, Link ~ MkLink api Link, IsElem api api)
         proxyApi = Proxy :: Proxy api
 
 swaggerSchemaUIServerImpl
-    :: (Server api ~ Handler Swagger)
+    :: (Monad m, ServerT api m ~ m Swagger)
     => T.Text -> [(FilePath, ByteString)]
-    -> Swagger -> Server (SwaggerSchemaUI' dir api)
+    -> Swagger -> ServerT (SwaggerSchemaUI' dir api) m
 swaggerSchemaUIServerImpl indexTemplate files swagger
   = swaggerSchemaUIServerImpl' indexTemplate files $ return swagger
 
 -- | Use a custom server to serve the Swagger spec source.
 swaggerSchemaUIServerImpl'
-    :: T.Text -> [(FilePath, ByteString)]
-    -> Server api -> Server (SwaggerSchemaUI' dir api)
+    :: Monad m
+    => T.Text
+    -> [(FilePath, ByteString)]
+    -> ServerT api m
+    -> ServerT (SwaggerSchemaUI' dir api) m
 swaggerSchemaUIServerImpl' indexTemplate files server
        = server
     :<|> return (SwaggerUiHtml indexTemplate)

servant-swagger-ui/CHANGELOG.md

@@ -1,3 +1,7 @@
+- 0.3.4.3.37.2
+    - Update to `swagger-ui-3.37.2`
+	- Add `swaggerSchemaUIServerT` and `swaggerSchemaUIServerT'`
+
 - 0.3.4.3.36.1
     - Update to `swagger-ui-3.36.1`
 

servant-swagger-ui/servant-swagger-ui.cabal

@@ -1,6 +1,6 @@
 cabal-version:      1.12
 name:               servant-swagger-ui
-version:            0.3.4.3.36.1
+version:            0.3.4.3.37.2
 synopsis:           Servant swagger ui
 category:           Web, Servant, Swagger
 description:
@@ -28,13 +28,13 @@ tested-with:
 extra-source-files:
   CHANGELOG.md
   index.html.tmpl
-  swagger-ui-dist-3.36.1/favicon-16x16.png
-  swagger-ui-dist-3.36.1/favicon-32x32.png
-  swagger-ui-dist-3.36.1/oauth2-redirect.html
-  swagger-ui-dist-3.36.1/swagger-ui-bundle.js
-  swagger-ui-dist-3.36.1/swagger-ui-standalone-preset.js
-  swagger-ui-dist-3.36.1/swagger-ui.css
-  swagger-ui-dist-3.36.1/swagger-ui.js
+  swagger-ui-dist-3.37.2/favicon-16x16.png
+  swagger-ui-dist-3.37.2/favicon-32x32.png
+  swagger-ui-dist-3.37.2/oauth2-redirect.html
+  swagger-ui-dist-3.37.2/swagger-ui-bundle.js
+  swagger-ui-dist-3.37.2/swagger-ui-standalone-preset.js
+  swagger-ui-dist-3.37.2/swagger-ui.css
+  swagger-ui-dist-3.37.2/swagger-ui.js
 
 source-repository head
   type:     git

servant-swagger-ui/src/Servant/Swagger/UI.hs

@@ -46,7 +46,9 @@ module Servant.Swagger.UI (
     SwaggerSchemaUI,
     SwaggerSchemaUI',
     swaggerSchemaUIServer,
+    swaggerSchemaUIServerT,
     swaggerSchemaUIServer',
+    swaggerSchemaUIServerT',
 
     -- ** Official swagger ui
     swaggerUiIndexTemplate,
@@ -72,6 +74,19 @@ swaggerSchemaUIServer
 swaggerSchemaUIServer =
     swaggerSchemaUIServerImpl swaggerUiIndexTemplate swaggerUiFiles
 
+-- | Serve Swagger UI on @/dir@ using @api@ as a Swagger spec source.
+--
+-- Generalized to 'ServerT'
+--
+-- @
+-- swaggerSchemaUIServerT :: Swagger -> ServerT (SwaggerSchemaUI schema dir) m
+-- @
+swaggerSchemaUIServerT
+    :: (Monad m, ServerT api m ~ m Swagger)
+    => Swagger -> ServerT (SwaggerSchemaUI' dir api) m
+swaggerSchemaUIServerT =
+    swaggerSchemaUIServerImpl swaggerUiIndexTemplate swaggerUiFiles
+
 -- | Use a custom server to serve the Swagger spec source.
 --
 -- This allows even more control over how the spec source is served.
@@ -83,8 +98,22 @@ swaggerSchemaUIServer'
 swaggerSchemaUIServer' =
     swaggerSchemaUIServerImpl' swaggerUiIndexTemplate swaggerUiFiles
 
+-- | Use a custom server to serve the Swagger spec source.
+--
+-- This allows even more control over how the spec source is served.
+-- It allows, for instance, serving the spec source with authentication,
+-- customizing the response based on the client or serving a swagger.yaml
+-- instead.
+--
+-- Generalized to 'ServerT'
+--
+swaggerSchemaUIServerT'
+    :: Monad m => ServerT api m -> ServerT (SwaggerSchemaUI' dir api) m
+swaggerSchemaUIServerT' =
+    swaggerSchemaUIServerImpl' swaggerUiIndexTemplate swaggerUiFiles
+
 swaggerUiIndexTemplate :: Text
 swaggerUiIndexTemplate = $(embedText "index.html.tmpl")
 
 swaggerUiFiles :: [(FilePath, ByteString)]
-swaggerUiFiles = $(embedRecursiveDir "swagger-ui-dist-3.36.1")
+swaggerUiFiles = $(embedRecursiveDir "swagger-ui-dist-3.37.2")