This repository was archived by the owner on Nov 11, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathswagger.go
More file actions
225 lines (205 loc) · 6.89 KB
/
swagger.go
File metadata and controls
225 lines (205 loc) · 6.89 KB
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
package swagger
import (
"github.com/gowool/wool"
swaggerFiles "github.com/swaggo/files"
"github.com/swaggo/swag"
"golang.org/x/net/webdav"
"html/template"
"net/http"
"path/filepath"
"regexp"
"sync"
)
type Config struct {
// The url pointing to API definition (normally swagger.json or swagger.yaml).
URL string `mapstructure:"url"`
DocExpansion string `mapstructure:"doc_expansion"`
DomID string `mapstructure:"dom_id"`
InstanceName string `mapstructure:"instance_name"`
DeepLinking *bool `mapstructure:"deep_linking"`
PersistAuthorization bool `mapstructure:"persist_authorization"`
SyntaxHighlight *bool `mapstructure:"syntax_highlight"`
// The information for OAuth2 integration, if any.
OAuth *OAuthConfig `mapstructure:"oauth"`
}
func (cfg *Config) Init() {
if cfg.URL == "" {
cfg.URL = "doc.json"
}
if cfg.DocExpansion == "" {
cfg.DocExpansion = "list"
}
if cfg.DomID == "" {
cfg.DomID = "swagger-ui"
}
if cfg.InstanceName == "" {
cfg.InstanceName = swag.Name
}
enable := true
if cfg.DeepLinking == nil {
cfg.DeepLinking = &enable
}
if cfg.SyntaxHighlight == nil {
cfg.SyntaxHighlight = &enable
}
}
// OAuthConfig stores configuration for Config UI OAuth2 integration. See
// https://swagger.io/docs/open-source-tools/swagger-ui/usage/oauth2/ for further details.
type OAuthConfig struct {
// The ID of the client sent to the OAuth2 IAM provider.
ClientId string `mapstructure:"client_id"`
// The OAuth2 realm that the client should operate in. If not applicable, use empty string.
Realm string `mapstructure:"realm"`
// The name to display for the application in the authentication popup.
AppName string `mapstructure:"app_name"`
}
type Swagger struct {
cfg *Config
index *template.Template
re *regexp.Regexp
h *webdav.Handler
once sync.Once
}
func New(cfg *Config) *Swagger {
return NewWithTemplate(cfg, nil)
}
func NewWithTemplate(cfg *Config, index *template.Template) *Swagger {
cfg.Init()
if index == nil {
index = template.Must(template.New("swagger_index.html").Parse(indexTemplate))
}
h := &webdav.Handler{
FileSystem: swaggerFiles.FS,
LockSystem: webdav.NewMemLS(),
}
return &Swagger{
cfg: cfg,
index: index,
re: regexp.MustCompile(`^(.*/)([^?].*)?[?|.]*$`),
h: h,
}
}
func (s *Swagger) Handler(c wool.Ctx) error {
matches := s.re.FindStringSubmatch(c.Req().RequestURI)
path := matches[2]
s.once.Do(func() {
s.h.Prefix = matches[1]
})
switch filepath.Ext(path) {
case ".html":
c.Res().Header().Set(wool.HeaderContentType, wool.MIMETextHTMLCharsetUTF8)
case ".css":
c.Res().Header().Set(wool.HeaderContentType, "text/css; charset=utf-8")
case ".js":
c.Res().Header().Set(wool.HeaderContentType, wool.MIMETextJavaScript)
case ".json":
c.Res().Header().Set(wool.HeaderContentType, wool.MIMEApplicationJSONCharsetUTF8)
case ".png":
c.Res().Header().Set(wool.HeaderContentType, "image/png")
}
switch path {
case "":
return c.Redirect(http.StatusMovedPermanently, s.h.Prefix+"index.html")
case "index.html":
return s.index.Execute(c.Res(), s.cfg)
case "doc.json":
doc, err := swag.ReadDoc(s.cfg.InstanceName)
if err != nil {
return err
}
_, err = c.Res().WriteString(doc)
return err
default:
return wool.ToHandler(s.h)(c)
}
}
const indexTemplate = `<!-- HTML for static distribution bundle build -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Swagger UI</title>
<link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
<link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
<link rel="icon" type="image/png" href="./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="{{.DomID}}"></div>
<script src="./swagger-ui-bundle.js"> </script>
<script src="./swagger-ui-standalone-preset.js"> </script>
<script>
window.onload = function() {
// Build a system
const ui = SwaggerUIBundle({
url: "{{.URL}}",
syntaxHighlight: {{.SyntaxHighlight}},
deepLinking: {{.DeepLinking}},
docExpansion: "{{.DocExpansion}}",
persistAuthorization: {{.PersistAuthorization}},
dom_id: "#{{.DomID}}",
validatorUrl: null,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout"
})
{{if .OAuth}}
ui.initOAuth({
clientId: "{{.OAuth.ClientId}}",
realm: "{{.OAuth.Realm}}",
appName: "{{.OAuth.AppName}}"
})
{{end}}
window.ui = ui
}
</script>
</body>
</html>
`