swagger

Documentation

Overview

Package swagger provides an HTTP handler to serve Swagger UI with embedded OpenAPI specs.

Index

• type Config
• type Handler
  • func New(swaggerUIZip []byte, config Config) (*Handler, error)
  • func (h *Handler) Routes(mux *http.ServeMux)
  • func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) ServeResources(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) ServeSpec(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) ServeUI(w http.ResponseWriter, r *http.Request)
• type Resource

Types

type Config

type Config struct {
	// BasePath is the URL path prefix where Swagger UI is served (e.g., "/swagger")
	BasePath string
	// SpecPath is the URL path to serve the OpenAPI spec (e.g., "/openapi/specs")
	SpecPath string
	// ResourcesPath is the URL path to serve the resources list (e.g., "/openapi/resources")
	ResourcesPath string
	// Specs is a map of spec name to spec content (YAML or JSON bytes)
	Specs map[string][]byte
	// DefaultSpec is the name of the default spec to serve when no query param is provided
	DefaultSpec string
}

Config holds the configuration for the Swagger UI handler.

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

Handler serves Swagger UI and OpenAPI specifications.

func New

func New(swaggerUIZip []byte, config Config) (*Handler, error)

New creates a new Swagger UI handler with the given configuration. swaggerUIZip should be the bytes of the swagger-ui.zip file.

func (*Handler) Routes

func (h *Handler) Routes(mux *http.ServeMux)

Routes registers the handler routes on the given mux.

func (*Handler) ServeHTTP

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

ServeHTTP implements http.Handler.

func (*Handler) ServeResources

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

ServeResources serves the resources list. Use with chi: router.Get("/openapi/resources", h.ServeResources)

func (*Handler) ServeSpec

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

ServeSpec serves the OpenAPI spec. Use with chi: router.Get("/openapi/specs", h.ServeSpec)

func (*Handler) ServeUI

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

ServeUI serves Swagger UI files. Use this when the router strips the base path (e.g., chi.Mount). The path should be relative to the mount point.

type Resource

type Resource struct {
	Name string `json:"name"`
	URL  string `json:"url"`
}

Resource represents a named OpenAPI spec URL for the Swagger UI dropdown.