File tree Expand file tree Collapse file tree 1 file changed +28
-0
lines changed
servant-swagger-ui-redoc/src/Servant/Swagger/UI Expand file tree Collapse file tree 1 file changed +28
-0
lines changed Original file line number Diff line number Diff line change @@ -46,7 +46,9 @@ module Servant.Swagger.UI.ReDoc (
46
46
SwaggerSchemaUI ,
47
47
SwaggerSchemaUI' ,
48
48
redocSchemaUIServer ,
49
+ redocSchemaUIServerT ,
49
50
redocSchemaUIServer' ,
51
+ redocSchemaUIServerT' ,
50
52
51
53
-- ** ReDoc theme
52
54
redocIndexTemplate ,
@@ -70,12 +72,38 @@ redocSchemaUIServer
70
72
redocSchemaUIServer =
71
73
swaggerSchemaUIServerImpl redocIndexTemplate redocFiles
72
74
75
+ -- | Serve Redoc Swagger UI on @/dir@ using @api@ as a Swagger spec source.
76
+ --
77
+ -- Generalized to 'ServerT'
78
+ --
79
+ -- @
80
+ -- redocSchemaUIServerT :: Swagger -> ServerT (SwaggerSchemaUI schema dir) m
81
+ -- @
82
+ redocSchemaUIServerT
83
+ :: (Monad m , ServerT api m ~ m Swagger )
84
+ => Swagger -> ServerT (SwaggerSchemaUI' dir api ) m
85
+ redocSchemaUIServerT =
86
+ swaggerSchemaUIServerImpl redocIndexTemplate redocFiles
87
+
73
88
-- | Use a custom server to serve the Swagger spec source.
74
89
redocSchemaUIServer'
75
90
:: Server api -> Server (SwaggerSchemaUI' dir api )
76
91
redocSchemaUIServer' =
77
92
swaggerSchemaUIServerImpl' redocIndexTemplate redocFiles
78
93
94
+ -- | Use a custom server to serve the Redoc Swagger spec source.
95
+ --
96
+ -- This allows even more control over how the spec source is served.
97
+ -- It allows, for instance, serving the spec source with authentication,
98
+ -- customizing the response based on the client or serving a swagger.yaml
99
+ -- instead.
100
+ --
101
+ -- Generalized to 'ServerT'
102
+ --
103
+ redocSchemaUIServerT'
104
+ :: Monad m => ServerT api m -> ServerT (SwaggerSchemaUI' dir api ) m
105
+ redocSchemaUIServerT' =
106
+ swaggerSchemaUIServerImpl' redocIndexTemplate redocFiles
79
107
80
108
redocIndexTemplate :: Text
81
109
redocIndexTemplate = $ (embedText " redoc.index.html.tmpl" )
You can’t perform that action at this time.
0 commit comments