Allow custom servers for the Swagger spec file

enobayram · phadej · commit 3fd3d83ad991 · 2019-05-30T11:56:36.000+03:00
diff --git a/servant-swagger-ui-core/Changelog.md b/servant-swagger-ui-core/Changelog.md
@@ -1,3 +1,7 @@
+# 0.3.3
+
+- Add `swaggerSchemaUIServerImpl'`
+
 # 0.3.1
 
 - Support `servant-0.14`
diff --git a/servant-swagger-ui-core/servant-swagger-ui-core.cabal b/servant-swagger-ui-core/servant-swagger-ui-core.cabal
@@ -1,7 +1,6 @@
 cabal-version:      1.12
 name:               servant-swagger-ui-core
-version:            0.3.2
-x-revision:         5
+version:            0.3.3
 synopsis:           Servant swagger ui core components
 category:           Web, Servant, Swagger
 description:
diff --git a/servant-swagger-ui-core/src/Servant/Swagger/UI/Core.hs b/servant-swagger-ui-core/src/Servant/Swagger/UI/Core.hs
@@ -42,6 +42,7 @@ module Servant.Swagger.UI.Core (
     -- * Implementation details
     SwaggerUiHtml(..),
     swaggerSchemaUIServerImpl,
+    swaggerSchemaUIServerImpl',
     Handler,
     ) where
 
@@ -103,7 +104,15 @@ swaggerSchemaUIServerImpl
     :: (Server api ~ Handler Swagger)
     => T.Text -> [(FilePath, ByteString)]
     -> Swagger -> Server (SwaggerSchemaUI' dir api)
-swaggerSchemaUIServerImpl indexTemplate files swagger = return swagger
+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)
+swaggerSchemaUIServerImpl' indexTemplate files server
+       = server
     :<|> return (SwaggerUiHtml indexTemplate)
     :<|> return (SwaggerUiHtml indexTemplate)
     :<|> rest
diff --git a/servant-swagger-ui-jensoleg/servant-swagger-ui-jensoleg.cabal b/servant-swagger-ui-jensoleg/servant-swagger-ui-jensoleg.cabal
@@ -1,7 +1,6 @@
 cabal-version:      1.12
 name:               servant-swagger-ui-jensoleg
-version:            0.3.2
-x-revision:         3
+version:            0.3.3
 synopsis:           Servant swagger ui: Jens-Ole Graulund theme
 category:           Web, Servant, Swagger
 description:
@@ -79,7 +78,7 @@ source-repository head
 library
   hs-source-dirs:   src
   ghc-options:      -Wall
-  build-depends:    servant-swagger-ui-core >=0.3.2 && <0.4
+  build-depends:    servant-swagger-ui-core >=0.3.3 && <0.4
   build-depends:
       base             >=4.7      && <4.13
     , bytestring       >=0.10.4.0 && <0.11
diff --git a/servant-swagger-ui-jensoleg/src/Servant/Swagger/UI/JensOleG.hs b/servant-swagger-ui-jensoleg/src/Servant/Swagger/UI/JensOleG.hs
@@ -46,6 +46,7 @@ module Servant.Swagger.UI.JensOleG (
     SwaggerSchemaUI,
     SwaggerSchemaUI',
     jensolegSwaggerSchemaUIServer,
+    jensolegSwaggerSchemaUIServer',
 
     -- ** ReDoc theme
     jensolegIndexTemplate,
@@ -71,6 +72,12 @@ jensolegSwaggerSchemaUIServer
 jensolegSwaggerSchemaUIServer =
     swaggerSchemaUIServerImpl jensolegIndexTemplate jensolegFiles
 
+-- | Use a custom server to serve the Swagger spec source.
+jensolegSwaggerSchemaUIServer'
+    :: Server api -> Server (SwaggerSchemaUI' dir api)
+jensolegSwaggerSchemaUIServer' =
+    swaggerSchemaUIServerImpl' jensolegIndexTemplate jensolegFiles
+
 jensolegIndexTemplate :: Text
 jensolegIndexTemplate = $(embedText "jensoleg.index.html.tmpl")
 
diff --git a/servant-swagger-ui-redoc/CHANGELOG.md b/servant-swagger-ui-redoc/CHANGELOG.md
@@ -1,3 +1,6 @@
+- 0.3.3.1.22.2
+    - Add `swaggerSchemaUIServer'`
+
 - 0.3.2.1.22.2
     - Update to ReDoc-1.22.2
     - Add GHC-8.6 support
diff --git a/servant-swagger-ui-redoc/servant-swagger-ui-redoc.cabal b/servant-swagger-ui-redoc/servant-swagger-ui-redoc.cabal
@@ -1,7 +1,6 @@
 cabal-version:      1.12
 name:               servant-swagger-ui-redoc
-version:            0.3.2.1.22.2
-x-revision:         3
+version:            0.3.3.1.22.2
 synopsis:           Servant swagger ui: ReDoc theme
 category:           Web, Servant, Swagger
 description:
@@ -33,7 +32,7 @@ source-repository head
 library
   hs-source-dirs:   src
   ghc-options:      -Wall
-  build-depends:    servant-swagger-ui-core >=0.3.2 && <0.4
+  build-depends:    servant-swagger-ui-core >=0.3.3 && <0.4
   build-depends:
       base             >=4.7      && <4.13
     , bytestring       >=0.10.4.0 && <0.11
diff --git a/servant-swagger-ui-redoc/src/Servant/Swagger/UI/ReDoc.hs b/servant-swagger-ui-redoc/src/Servant/Swagger/UI/ReDoc.hs
@@ -46,6 +46,7 @@ module Servant.Swagger.UI.ReDoc (
     SwaggerSchemaUI,
     SwaggerSchemaUI',
     redocSchemaUIServer,
+    redocSchemaUIServer',
 
     -- ** ReDoc theme
     redocIndexTemplate,
@@ -69,6 +70,13 @@ redocSchemaUIServer
 redocSchemaUIServer =
     swaggerSchemaUIServerImpl redocIndexTemplate redocFiles
 
+-- | Use a custom server to serve the Swagger spec source.
+redocSchemaUIServer'
+    :: Server api -> Server (SwaggerSchemaUI' dir api)
+redocSchemaUIServer' =
+    swaggerSchemaUIServerImpl' redocIndexTemplate redocFiles
+
+
 redocIndexTemplate :: Text
 redocIndexTemplate = $(embedText "redoc.index.html.tmpl")
 
diff --git a/servant-swagger-ui/CHANGELOG.md b/servant-swagger-ui/CHANGELOG.md
@@ -1,3 +1,7 @@
+- 0.3.3.3.22.2
+    - Update to `swagger-ui-3.22.2`
+    - Add `swaggerSchemaUIServer'`
+
 - 0.3.2.3.19.3
     - Update to `swagger-ui-3.19.3`
     - Add GHC-8.6 support
diff --git a/servant-swagger-ui/servant-swagger-ui.cabal b/servant-swagger-ui/servant-swagger-ui.cabal
@@ -1,6 +1,6 @@
 cabal-version:      1.12
 name:               servant-swagger-ui
-version:            0.3.2.3.22.2
+version:            0.3.3.3.22.2
 synopsis:           Servant swagger ui
 category:           Web, Servant, Swagger
 description:
@@ -37,7 +37,7 @@ source-repository head
 library
   hs-source-dirs:   src
   ghc-options:      -Wall
-  build-depends:    servant-swagger-ui-core ==0.3.*
+  build-depends:    servant-swagger-ui-core >=0.3.3 && <0.4
   build-depends:
       base             >=4.7      && <4.13
     , bytestring       >=0.10.4.0 && <0.11
diff --git a/servant-swagger-ui/src/Servant/Swagger/UI.hs b/servant-swagger-ui/src/Servant/Swagger/UI.hs
@@ -46,6 +46,7 @@ module Servant.Swagger.UI (
     SwaggerSchemaUI,
     SwaggerSchemaUI',
     swaggerSchemaUIServer,
+    swaggerSchemaUIServer',
 
     -- ** Official swagger ui
     swaggerUiIndexTemplate,
@@ -71,6 +72,17 @@ 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.
+swaggerSchemaUIServer'
+    :: Server api -> Server (SwaggerSchemaUI' dir api)
+swaggerSchemaUIServer' =
+    swaggerSchemaUIServerImpl' swaggerUiIndexTemplate swaggerUiFiles
+
 swaggerUiIndexTemplate :: Text
 swaggerUiIndexTemplate = $(embedText "index.html.tmpl")
 

-Original file line number
+Diff line change
@@ @@ -1,3 +1,7 @@ @@
 +# 0.3.3
++
 +- Add `swaggerSchemaUIServerImpl'`
++
 # 0.3.1
 - Support `servant-0.14`