2024-03-06 18:05:45 +01:00
|
|
|
package middleware
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"bytes"
|
|
|
|
|
"fmt"
|
|
|
|
|
"html/template"
|
|
|
|
|
"net/http"
|
|
|
|
|
"path"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
// RapiDocOpts configures the RapiDoc middlewares
|
|
|
|
|
type RapiDocOpts struct {
|
2024-04-26 11:31:10 +02:00
|
|
|
// BasePath for the UI, 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
|
|
|
|
2024-03-06 18:05:45 +01:00
|
|
|
// Title for the documentation site, default to: API documentation
|
|
|
|
|
Title string
|
2024-04-26 11:31:10 +02:00
|
|
|
|
|
|
|
|
// Template specifies a custom template to serve the UI
|
|
|
|
|
Template string
|
|
|
|
|
|
|
|
|
|
// RapiDocURL points to the js asset that generates the rapidoc site.
|
|
|
|
|
//
|
|
|
|
|
// Defaults to https://unpkg.com/rapidoc/dist/rapidoc-min.js
|
|
|
|
|
RapiDocURL string
|
2024-03-06 18:05:45 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (r *RapiDocOpts) EnsureDefaults() {
|
2024-04-26 11:31:10 +02:00
|
|
|
common := toCommonUIOptions(r)
|
|
|
|
|
common.EnsureDefaults()
|
|
|
|
|
fromCommonToAnyOptions(common, r)
|
|
|
|
|
|
|
|
|
|
// rapidoc-specifics
|
2024-03-06 18:05:45 +01:00
|
|
|
if r.RapiDocURL == "" {
|
|
|
|
|
r.RapiDocURL = rapidocLatest
|
|
|
|
|
}
|
2024-04-26 11:31:10 +02:00
|
|
|
if r.Template == "" {
|
|
|
|
|
r.Template = rapidocTemplate
|
2024-03-06 18:05:45 +01:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// RapiDoc creates a middleware to serve a documentation site for a swagger spec.
|
|
|
|
|
//
|
2024-04-26 11:31:10 +02:00
|
|
|
// This allows for altering the spec before starting the http listener.
|
2024-03-06 18:05:45 +01:00
|
|
|
func RapiDoc(opts RapiDocOpts, 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("rapidoc").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 18:05:45 +01:00
|
|
|
|
2024-04-26 11:31:10 +02:00
|
|
|
return serveUI(pth, assets.Bytes(), next)
|
2024-03-06 18:05:45 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const (
|
|
|
|
|
rapidocLatest = "https://unpkg.com/rapidoc/dist/rapidoc-min.js"
|
|
|
|
|
rapidocTemplate = `<!doctype html>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<title>{{ .Title }}</title>
|
2024-04-26 11:31:10 +02:00
|
|
|
<meta charset="utf-8"> <!-- Important: rapi-doc uses utf8 characters -->
|
2024-03-06 18:05:45 +01:00
|
|
|
<script type="module" src="{{ .RapiDocURL }}"></script>
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<rapi-doc spec-url="{{ .SpecURL }}"></rapi-doc>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
`
|
|
|
|
|
)
|
