2024-03-06 17:05:45 +00:00
|
|
|
package middleware
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"bytes"
|
|
|
|
|
"fmt"
|
|
|
|
|
"html/template"
|
|
|
|
|
"net/http"
|
|
|
|
|
"path"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
// RedocOpts configures the Redoc middlewares
|
|
|
|
|
type RedocOpts struct {
|
2024-04-26 09:31:10 +00:00
|
|
|
// BasePath for the UI, defaults to: /
|
2024-03-06 17:05:45 +00:00
|
|
|
BasePath string
|
2024-04-26 09:31:10 +00:00
|
|
|
|
|
|
|
|
// Path combines with BasePath to construct the path to the UI, defaults to: "docs".
|
2024-03-06 17:05:45 +00:00
|
|
|
Path string
|
2024-04-26 09:31:10 +00:00
|
|
|
|
|
|
|
|
// SpecURL is the URL of the spec document.
|
|
|
|
|
//
|
|
|
|
|
// Defaults to: /swagger.json
|
2024-03-06 17:05:45 +00:00
|
|
|
SpecURL string
|
2024-04-26 09:31:10 +00:00
|
|
|
|
2024-03-06 17:05:45 +00:00
|
|
|
// Title for the documentation site, default to: API documentation
|
|
|
|
|
Title string
|
2024-04-26 09:31:10 +00:00
|
|
|
|
|
|
|
|
// Template specifies a custom template to serve the UI
|
|
|
|
|
Template string
|
|
|
|
|
|
|
|
|
|
// RedocURL points to the js that generates the redoc site.
|
|
|
|
|
//
|
|
|
|
|
// Defaults to: https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js
|
|
|
|
|
RedocURL string
|
2024-03-06 17:05:45 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// EnsureDefaults in case some options are missing
|
|
|
|
|
func (r *RedocOpts) EnsureDefaults() {
|
2024-04-26 09:31:10 +00:00
|
|
|
common := toCommonUIOptions(r)
|
|
|
|
|
common.EnsureDefaults()
|
|
|
|
|
fromCommonToAnyOptions(common, r)
|
|
|
|
|
|
|
|
|
|
// redoc-specifics
|
2024-03-06 17:05:45 +00:00
|
|
|
if r.RedocURL == "" {
|
|
|
|
|
r.RedocURL = redocLatest
|
|
|
|
|
}
|
2024-04-26 09:31:10 +00:00
|
|
|
if r.Template == "" {
|
|
|
|
|
r.Template = redocTemplate
|
2024-03-06 17:05:45 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Redoc creates a middleware to serve a documentation site for a swagger spec.
|
|
|
|
|
//
|
2024-04-26 09:31:10 +00:00
|
|
|
// This allows for altering the spec before starting the http listener.
|
2024-03-06 17:05:45 +00:00
|
|
|
func Redoc(opts RedocOpts, next http.Handler) http.Handler {
|
|
|
|
|
opts.EnsureDefaults()
|
|
|
|
|
|
|
|
|
|
pth := path.Join(opts.BasePath, opts.Path)
|
2024-04-26 09:31:10 +00:00
|
|
|
tmpl := template.Must(template.New("redoc").Parse(opts.Template))
|
|
|
|
|
assets := bytes.NewBuffer(nil)
|
|
|
|
|
if err := tmpl.Execute(assets, opts); err != nil {
|
|
|
|
|
panic(fmt.Errorf("cannot execute template: %w", err))
|
|
|
|
|
}
|
2024-03-06 17:05:45 +00:00
|
|
|
|
2024-04-26 09:31:10 +00:00
|
|
|
return serveUI(pth, assets.Bytes(), next)
|
2024-03-06 17:05:45 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const (
|
|
|
|
|
redocLatest = "https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js"
|
|
|
|
|
redocTemplate = `<!DOCTYPE html>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<title>{{ .Title }}</title>
|
|
|
|
|
<!-- needed for adaptive design -->
|
|
|
|
|
<meta charset="utf-8"/>
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
|
|
|
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
|
ReDoc doesn't change outer page styles
|
|
|
|
|
-->
|
|
|
|
|
<style>
|
|
|
|
|
body {
|
|
|
|
|
margin: 0;
|
|
|
|
|
padding: 0;
|
|
|
|
|
}
|
|
|
|
|
</style>
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<redoc spec-url='{{ .SpecURL }}'></redoc>
|
|
|
|
|
<script src="{{ .RedocURL }}"> </script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
`
|
|
|
|
|
)
|
