swaggerui

package
v0.2.0 Latest Latest
Warning

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

 Go to latest Published: Apr 5, 2026 License: MIT Imports: 9 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IndexTpl 

func IndexTpl(assetsBase, faviconBase string, cfg *config.SwaggerUI) string

IndexTpl creates page template.

func WithUI 

func WithUI(cfg ...config.SwaggerUI) specui.Option

WithUI configures the handler to use Swagger UI, loading assets from CDN. An optional config.SwaggerUI value may be passed to customise the UI behaviour.

Types

type Data 

type Data struct {
	Title      string            `json:"title"`
	OpenAPIURL string            `json:"openapiURL"`
	HideCurl   bool              `json:"hideCurl"`
	JsonEditor bool              `json:"jsonEditor"`
	UIConfig   map[string]string `json:"-"`
}

type Handler 

type Handler struct {
	Data

	ConfigJson template.JS
	// contains filtered or unexported fields
}

Handler handles swagger UI request.

func NewHandler 

func NewHandler(config *config.SpecUI) *Handler

NewHandler returns a HTTP handler for swagger UI.

func (*Handler) ServeHTTP 

func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements http.Handler interface to handle swagger UI request.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.