2024-03-06 18:05:45 +01:00
|
|
|
package middleware
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"bytes"
|
|
|
|
|
"fmt"
|
|
|
|
|
"html/template"
|
|
|
|
|
"net/http"
|
|
|
|
|
"path"
|
|
|
|
|
)
|
|
|
|
|
|
2024-04-26 11:31:10 +02:00
|
|
|
// SwaggerUIOpts configures the SwaggerUI middleware
|
2024-03-06 18:05:45 +01:00
|
|
|
type SwaggerUIOpts struct {
|
2024-04-26 11:31:10 +02:00
|
|
|
// BasePath for the API, defaults to: /
|
2024-03-06 18:05:45 +01:00
|
|
|
BasePath string
|
2024-04-26 11:31:10 +02:00
|
|
|
|
|
|
|
|
// Path combines with BasePath to construct the path to the UI, defaults to: "docs".
|
2024-03-06 18:05:45 +01:00
|
|
|
Path string
|
2024-04-26 11:31:10 +02:00
|
|
|
|
|
|
|
|
// SpecURL is the URL of the spec document.
|
|
|
|
|
//
|
|
|
|
|
// Defaults to: /swagger.json
|
2024-03-06 18:05:45 +01:00
|
|
|
SpecURL string
|
2024-04-26 11:31:10 +02:00
|
|
|
|
|
|
|
|
// Title for the documentation site, default to: API documentation
|
|
|
|
|
Title string
|
|
|
|
|
|
|
|
|
|
// Template specifies a custom template to serve the UI
|
|
|
|
|
Template string
|
|
|
|
|
|
2024-03-06 18:05:45 +01:00
|
|
|
// OAuthCallbackURL the url called after OAuth2 login
|
|
|
|
|
OAuthCallbackURL string
|
|
|
|
|
|
|
|
|
|
// The three components needed to embed swagger-ui
|
2024-04-26 11:31:10 +02:00
|
|
|
|
|
|
|
|
// SwaggerURL points to the js that generates the SwaggerUI site.
|
|
|
|
|
//
|
|
|
|
|
// Defaults to: https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js
|
|
|
|
|
SwaggerURL string
|
|
|
|
|
|
2024-03-06 18:05:45 +01:00
|
|
|
SwaggerPresetURL string
|
|
|
|
|
SwaggerStylesURL string
|
|
|
|
|
|
|
|
|
|
Favicon32 string
|
|
|
|
|
Favicon16 string
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// EnsureDefaults in case some options are missing
|
|
|
|
|
func (r *SwaggerUIOpts) EnsureDefaults() {
|
2024-04-26 11:31:10 +02:00
|
|
|
r.ensureDefaults()
|
|
|
|
|
|
|
|
|
|
if r.Template == "" {
|
|
|
|
|
r.Template = swaggeruiTemplate
|
2024-03-06 18:05:45 +01:00
|
|
|
}
|
2024-04-26 11:31:10 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (r *SwaggerUIOpts) EnsureDefaultsOauth2() {
|
|
|
|
|
r.ensureDefaults()
|
|
|
|
|
|
|
|
|
|
if r.Template == "" {
|
|
|
|
|
r.Template = swaggerOAuthTemplate
|
2024-03-06 18:05:45 +01:00
|
|
|
}
|
2024-04-26 11:31:10 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (r *SwaggerUIOpts) ensureDefaults() {
|
|
|
|
|
common := toCommonUIOptions(r)
|
|
|
|
|
common.EnsureDefaults()
|
|
|
|
|
fromCommonToAnyOptions(common, r)
|
|
|
|
|
|
|
|
|
|
// swaggerui-specifics
|
2024-03-06 18:05:45 +01:00
|
|
|
if r.OAuthCallbackURL == "" {
|
|
|
|
|
r.OAuthCallbackURL = path.Join(r.BasePath, r.Path, "oauth2-callback")
|
|
|
|
|
}
|
|
|
|
|
if r.SwaggerURL == "" {
|
|
|
|
|
r.SwaggerURL = swaggerLatest
|
|
|
|
|
}
|
|
|
|
|
if r.SwaggerPresetURL == "" {
|
|
|
|
|
r.SwaggerPresetURL = swaggerPresetLatest
|
|
|
|
|
}
|
|
|
|
|
if r.SwaggerStylesURL == "" {
|
|
|
|
|
r.SwaggerStylesURL = swaggerStylesLatest
|
|
|
|
|
}
|
|
|
|
|
if r.Favicon16 == "" {
|
|
|
|
|
r.Favicon16 = swaggerFavicon16Latest
|
|
|
|
|
}
|
|
|
|
|
if r.Favicon32 == "" {
|
|
|
|
|
r.Favicon32 = swaggerFavicon32Latest
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// SwaggerUI creates a middleware to serve a documentation site for a swagger spec.
|
2024-04-26 11:31:10 +02:00
|
|
|
//
|
2024-03-06 18:05:45 +01:00
|
|
|
// This allows for altering the spec before starting the http listener.
|
|
|
|
|
func SwaggerUI(opts SwaggerUIOpts, next http.Handler) http.Handler {
|
|
|
|
|
opts.EnsureDefaults()
|
|
|
|
|
|
|
|
|
|
pth := path.Join(opts.BasePath, opts.Path)
|
2024-04-26 11:31:10 +02:00
|
|
|
tmpl := template.Must(template.New("swaggerui").Parse(opts.Template))
|
|
|
|
|
assets := bytes.NewBuffer(nil)
|
|
|
|
|
if err := tmpl.Execute(assets, opts); err != nil {
|
|
|
|
|
panic(fmt.Errorf("cannot execute template: %w", err))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return serveUI(pth, assets.Bytes(), next)
|
2024-03-06 18:05:45 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const (
|
|
|
|
|
swaggerLatest = "https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"
|
|
|
|
|
swaggerPresetLatest = "https://unpkg.com/swagger-ui-dist/swagger-ui-standalone-preset.js"
|
|
|
|
|
swaggerStylesLatest = "https://unpkg.com/swagger-ui-dist/swagger-ui.css"
|
|
|
|
|
swaggerFavicon32Latest = "https://unpkg.com/swagger-ui-dist/favicon-32x32.png"
|
|
|
|
|
swaggerFavicon16Latest = "https://unpkg.com/swagger-ui-dist/favicon-16x16.png"
|
|
|
|
|
swaggeruiTemplate = `
|
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="UTF-8">
|
|
|
|
|
<title>{{ .Title }}</title>
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="{{ .SwaggerStylesURL }}" >
|
|
|
|
|
<link rel="icon" type="image/png" href="{{ .Favicon32 }}" sizes="32x32" />
|
|
|
|
|
<link rel="icon" type="image/png" href="{{ .Favicon16 }}" 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>
|
|
|
|
|
<div id="swagger-ui"></div>
|
|
|
|
|
|
|
|
|
|
<script src="{{ .SwaggerURL }}"> </script>
|
|
|
|
|
<script src="{{ .SwaggerPresetURL }}"> </script>
|
|
|
|
|
<script>
|
|
|
|
|
window.onload = function() {
|
|
|
|
|
// Begin Swagger UI call region
|
|
|
|
|
const ui = SwaggerUIBundle({
|
|
|
|
|
url: '{{ .SpecURL }}',
|
|
|
|
|
dom_id: '#swagger-ui',
|
|
|
|
|
deepLinking: true,
|
|
|
|
|
presets: [
|
|
|
|
|
SwaggerUIBundle.presets.apis,
|
|
|
|
|
SwaggerUIStandalonePreset
|
|
|
|
|
],
|
|
|
|
|
plugins: [
|
|
|
|
|
SwaggerUIBundle.plugins.DownloadUrl
|
|
|
|
|
],
|
|
|
|
|
layout: "StandaloneLayout",
|
|
|
|
|
oauth2RedirectUrl: '{{ .OAuthCallbackURL }}'
|
|
|
|
|
})
|
|
|
|
|
// End Swagger UI call region
|
|
|
|
|
|
|
|
|
|
window.ui = ui
|
|
|
|
|
}
|
|
|
|
|
</script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
`
|
|
|
|
|
)
|
