stoplight

package

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

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/oaswrap/spec-ui

Links

Open Source Insights

Documentation ¶

Index ¶

func IndexTpl(assetBase, faviconBase string, specCfg *config.SpecUI) string
func WithUI(cfg ...config.StoplightElements) specui.Option
type Data
type Handler
- func NewHandler(cfg *config.SpecUI) *Handler
- func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func IndexTpl ¶

func IndexTpl(assetBase, faviconBase string, specCfg *config.SpecUI) string

func WithUI ¶

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

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

Types ¶

type Data ¶

type Data struct {
	Title          string               `json:"title"`
	OpenAPIURL     string               `json:"openapiURL"`
	HideExport     bool                 `json:"hideExport"`
	HideSchemas    bool                 `json:"hideSchemas"`
	HideTryIt      bool                 `json:"hideTryIt"`
	HideTryItPanel bool                 `json:"hideTryItPanel"`
	Layout         config.ElementLayout `json:"layout"`
	Logo           string               `json:"logo"`
	Router         config.ElementRouter `json:"router"`
}

type Handler ¶

type Handler struct {
	Data

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

Handler handles swagger UI request.

func NewHandler ¶

func NewHandler(cfg *config.SpecUI) *Handler

NewHandler returns a HTTP handler for swagger UI.

func (*Handler) ServeHTTP ¶

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

Source Files ¶

View all Source files

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