-
-
Notifications
You must be signed in to change notification settings - Fork 32
/
swagger.go
332 lines (304 loc) · 9.45 KB
/
swagger.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
package swagger
import (
"fmt"
"html/template"
"os"
"regexp"
"strings"
"golang.org/x/net/webdav"
"github.com/kataras/iris/v12"
"github.com/swaggo/swag"
)
// Configurator represents a configuration setter.
type Configurator interface {
Configure(*Config)
}
// ConfiguratorFunc implements the Configuration as a function type.
type ConfiguratorFunc func(*Config)
// Configure calls itself and modifies the default config.
func (fn ConfiguratorFunc) Configure(config *Config) {
fn(config)
}
// Config stores swagger configuration variables.
type Config struct {
// The URL pointing to API definition (normally swagger.json or swagger.yaml).
// Default is `swagger.json`.
URL string
// The prefix url which this swagger ui is registered on.
// Defaults to "/swagger". It can be a "." too.
Prefix string
FontCDN string
Theme Theme
DeepLinking bool
DocExpansion string
DomID string
// Enabling tag Filtering
Filter bool
}
// Configure completes the Configurator interface.
// It allows to pass a Config as it is and override any option.
func (c Config) Configure(config *Config) {
config.URL = c.URL
config.Prefix = c.Prefix
config.DeepLinking = c.DeepLinking
config.DocExpansion = c.DocExpansion
config.DomID = c.DomID
config.Filter = c.Filter
}
// URL presents the URL pointing to API definition (normally swagger.json or swagger.yaml).
func URL(url string) ConfiguratorFunc {
return func(c *Config) {
c.URL = url
}
}
// Prefix presents the URL prefix of this swagger UI (normally "/swagger" or ".").
func Prefix(prefix string) ConfiguratorFunc {
return func(c *Config) {
c.Prefix = prefix
}
}
// Change google font cdn to any you like.
func FontCDN(cdn string) ConfiguratorFunc {
cdn = strings.TrimSuffix(cdn, "/")
return func(c *Config) {
c.FontCDN = cdn
}
}
type Theme string
const (
FeelingBlue Theme = "feeling-blue"
Material Theme = "material"
Muted Theme = "muted"
Outline Theme = "outline"
Flattop Theme = "flattop"
Monokai Theme = "monokai"
Newspaper Theme = "newspaper"
Unknow Theme = "unknow"
)
func (t Theme) String() string {
switch t {
case FeelingBlue:
fallthrough
case Material:
fallthrough
case Muted:
fallthrough
case Outline:
fallthrough
case Flattop:
fallthrough
case Monokai:
fallthrough
case Newspaper:
themeName := string(t)
return fmt.Sprintf("theme-%s", themeName)
default:
return "unknow"
}
}
func (t Theme) IsValid() bool {
return t != Unknow
}
func SetTheme(theme Theme) ConfiguratorFunc {
return func(c *Config) {
c.Theme = theme
}
}
// DocExpansion list, full, none.
func DocExpansion(docExpansion string) ConfiguratorFunc {
return func(c *Config) {
c.DocExpansion = docExpansion
}
}
// DomID #swagger-ui.
func DomID(domID string) ConfiguratorFunc {
return func(c *Config) {
c.DomID = domID
}
}
// DeepLinking set the swagger deeplinking configuration.
func DeepLinking(deepLinking bool) ConfiguratorFunc {
return func(c *Config) {
c.DeepLinking = deepLinking
}
}
var instanceNameRegex = regexp.MustCompile(`^/(\w+)\.json$`)
// Handler wraps the webdav http handler into an Iris Handler one.
//
// Usage:
//
// swaggerUI := swagger.Handler(swaggerFiles.Handler,
// swagger.URL("http://localhost:8080/swagger/swagger.json"), // The url pointing to API definition))
// swagger.DeepLinking(true),
// swagger.Prefix("/swagger"),
// )
// app.Get("/swagger", swaggerUI)
// app.Get("/swagger/{any:path}", swaggerUI)
//
// OR
//
// swaggerUI := swagger.Handler(swaggerFiles.Handler, swagger.Config{
// URL: ...,
// Prefix: ...,
// DeepLinking: ...,
// DocExpansion: ...,
// DomID: ...,
// }
func Handler(h *webdav.Handler, configurators ...Configurator) iris.Handler {
config := &Config{
URL: "swagger/swagger.json",
DeepLinking: true,
DocExpansion: "list",
DomID: "#swagger-ui",
Prefix: "/swagger",
FontCDN: "https://fonts.googleapis.com",
Theme: Unknow,
Filter: true,
}
for _, c := range configurators {
c.Configure(config)
}
if prefix := config.Prefix; prefix != "" && prefix != "." {
h.Prefix = prefix
} else {
config.Prefix = "." // relative files and don't touch the webdav one's (index swagger will not work without index.html).
}
handler := func(ctx iris.Context) {
path := strings.TrimPrefix(ctx.Path(), config.Prefix)
if sufIdx := strings.LastIndexByte(path, '.'); sufIdx > 0 {
suffix := path[sufIdx:]
switch suffix {
case ".html":
ctx.ContentType("text/html; charset=utf-8")
case ".css":
ctx.ContentType("text/css; charset=utf-8")
case ".js":
ctx.ContentType("application/javascript")
case ".json":
ctx.ContentType("application/json")
}
}
if match := instanceNameRegex.FindStringSubmatch(path); match != nil {
doc, err := swag.ReadDoc(match[1]) // default instance name is swagger
if err != nil {
ctx.Application().Logger().Errorf("swagger: %v", err)
ctx.StopWithStatus(iris.StatusInternalServerError)
return
}
ctx.WriteString(doc)
return
}
switch path {
case "", "/", "/index.html":
ctx.ContentType("text/html; charset=utf-8")
err := indexTmpl.Execute(ctx, config)
if err != nil {
ctx.Application().Logger().Errorf("swagger: %v", err)
ctx.StopWithStatus(iris.StatusInternalServerError)
return
}
default:
h.ServeHTTP(ctx.ResponseWriter(), ctx.Request())
}
}
return handler
}
// DisablingHandler turns handler off
// if specified environment variable passed.
func DisablingHandler(h *webdav.Handler, envName string, configurators ...Configurator) iris.Handler {
eFlag := os.Getenv(envName)
if eFlag != "" {
return func(ctx iris.Context) {
// Simulate behavior when route unspecified and
// return 404 HTTP code
ctx.NotFound()
}
}
return Handler(h, configurators...)
}
var indexTmpl = template.Must(template.New("swagger_index.html").Parse(`<!-- HTML for static distribution bundle build -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Swagger UI</title>
<link href="{{.FontCDN}}/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet">
<link rel="stylesheet" type="text/css" href="{{.Prefix}}/swagger-ui.css" >
{{if .Theme.IsValid }}
<link rel="stylesheet" type="text/css" href="{{.Prefix}}/{{.Theme}}.css">
{{end}}
<link rel="icon" type="image/png" href="{{.Prefix}}/favicon-32x32.png" sizes="32x32" />
<link rel="icon" type="image/png" href="{{.Prefix}}/favicon-16x16.png" sizes="16x16" />
<style>
html
{
box-sizing: border-box;
overflow: -moz-scrollbars-vertical;
overflow-y: scroll;
}
*,
*:before,
*:after
{
box-sizing: inherit;
}
body {
margin:0;
background: #fafafa;
}
</style>
</head>
<body>
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position:absolute;width:0;height:0">
<defs>
<symbol viewBox="0 0 20 20" id="unlocked">
<path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>
</symbol>
<symbol viewBox="0 0 20 20" id="locked">
<path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"/>
</symbol>
<symbol viewBox="0 0 20 20" id="close">
<path d="M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z"/>
</symbol>
<symbol viewBox="0 0 20 20" id="large-arrow">
<path d="M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z"/>
</symbol>
<symbol viewBox="0 0 20 20" id="large-arrow-down">
<path d="M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z"/>
</symbol>
<symbol viewBox="0 0 24 24" id="jump-to">
<path d="M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z"/>
</symbol>
<symbol viewBox="0 0 24 24" id="expand">
<path d="M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z"/>
</symbol>
</defs>
</svg>
<div id="swagger-ui"></div>
<script src="{{.Prefix}}/swagger-ui-bundle.js"> </script>
<script src="{{.Prefix}}/swagger-ui-standalone-preset.js"> </script>
<script>
window.onload = function() {
// Build a system
const ui = SwaggerUIBundle({
url: "{{.URL}}",
deepLinking: {{.DeepLinking}},
docExpansion: "{{.DocExpansion}}",
dom_id: "{{.DomID}}",
validatorUrl: null,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout",
filter: {{.Filter}}
})
window.ui = ui
}
</script>
</body>
</html>
`))