package middleware import ( "bytes" "fmt" "html/template" "net/http" "path" ) // RedocOpts configures the Redoc middlewares type RedocOpts struct { // BasePath for the UI, defaults to: / BasePath string // Path combines with BasePath to construct the path to the UI, defaults to: "docs". Path string // SpecURL is the URL of the spec document. // // Defaults to: /swagger.json SpecURL string // Title for the documentation site, default to: API documentation Title string // 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 } // EnsureDefaults in case some options are missing func (r *RedocOpts) EnsureDefaults() { common := toCommonUIOptions(r) common.EnsureDefaults() fromCommonToAnyOptions(common, r) // redoc-specifics if r.RedocURL == "" { r.RedocURL = redocLatest } if r.Template == "" { r.Template = redocTemplate } } // Redoc creates a middleware to serve a documentation site for a swagger spec. // // This allows for altering the spec before starting the http listener. func Redoc(opts RedocOpts, next http.Handler) http.Handler { opts.EnsureDefaults() pth := path.Join(opts.BasePath, opts.Path) 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)) } return serveUI(pth, assets.Bytes(), next) } const ( redocLatest = "https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js" redocTemplate = `