specui

package module

v0.3.1 Latest Latest Go to latest Published: Aug 9, 2025 License: MIT Imports: 8 Imported by: 1

Details

View Source

const Filename = "openapi.yaml"

This section is empty.

This section is empty.

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

Handler provides methods to serve OpenAPI documentation and files.

func NewHandler(generator spec.Generator) *Handler

NewHandler creates a new Handler instance with the provided OpenAPI generator.

func (h *Handler) Docs() http.Handler

Docs returns an HTTP handler that serves the OpenAPI documentation UI.

func (h *Handler) DocsFile() http.Handler

DocsFile returns an HTTP handler that serves the OpenAPI schema file.

func (h *Handler) DocsFileFunc() http.HandlerFunc

DocsFileFunc returns an HTTP handler function that serves the OpenAPI schema file.

func (h *Handler) DocsFilePath() string

DocsFilePath returns the path for the OpenAPI schema file.

func (h *Handler) DocsFunc() http.HandlerFunc

DocsFunc returns an HTTP handler function that serves the OpenAPI documentation UI.

func (h *Handler) DocsPath() string

DocsPath returns the path for the OpenAPI documentation.