ui

package
v0.1.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 24, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterSwaggerUI

func RegisterSwaggerUI(mux interface {
	Get(string, http.HandlerFunc)
}, cfg SwaggerUIConfig)

func WriteSwaggerUIHTML

func WriteSwaggerUIHTML(w io.Writer, cfg SwaggerUIConfig)

WriteSwaggerUIHTML renders the embedded Swagger UI template into the provided writer.

It intentionally does not register any routes; use RegisterSwaggerUI for that.

Types

type SwaggerUIConfig

type SwaggerUIConfig struct {
	MountPath   string // default: /swagger-ui
	SpecURLPath string // default: /openapi.json
	Version     string // optional: used for cache busting assets like favicon
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL