openapi

Documentation

Index

• type Handler
  • func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type HandlerBuilder
  • func NewHandler() *HandlerBuilder
  • func (b *HandlerBuilder) Build() (result *Handler, err error)
  • func (b *HandlerBuilder) SetLogger(value *slog.Logger) *HandlerBuilder

Types

type Handler

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

Handler knows how to respond to requests for the OpenAPI metadata. Don't create instances of this type directly, use the NewHandler function instead.

func (*Handler) ServeHTTP

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

ServeHTTP is the implementation of the object HTTP handler interface.

type HandlerBuilder

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

HandlerBuilder contains the data and logic needed to create a new handler for the OpenAPI metadata. Don't create instances of this type directly, use the NewHandler function instead.

func NewHandler

func NewHandler() *HandlerBuilder

NewHandler creates a builder that can then be used to configure and create a handler for the OpenAPI metadata.

func (*HandlerBuilder) Build

func (b *HandlerBuilder) Build() (result *Handler, err error)

Build uses the data stored in the builder to create and configure a new handler.

func (*HandlerBuilder) SetLogger

func (b *HandlerBuilder) SetLogger(value *slog.Logger) *HandlerBuilder

SetLogger sets the logger that the handler will use to write to the log. This is mandatory.