shiftapi

Mar 11, 2026

Changes in this version

+ func HandleSSE[In, Event any](router Router, pattern string, fn SSEHandlerFunc[In, Event], ...)

+ func HandleWS[In any](router Router, pattern string, msgs *WSMessages[In], options ...WSOption)

+ func SSESends(variants ...SSEEventVariant) sseOptionFunc

+ func WithWSAcceptOptions(opts WSAcceptOptions) wsOptionFunc

+ type SSEEventVariant interface

+ func SSEEventType[T any](name string) SSEEventVariant

+ type SSEHandlerFunc func(r *http.Request, in In, sse *SSEWriter[Event]) error

+ type SSEOption interface

+ type SSEWriter struct

+ func (s *SSEWriter[Event]) Send(v Event) error

+ type WSAcceptOptions struct

+ OriginPatterns []string

+ Subprotocols []string

+ type WSDecodeError struct

+ func (e *WSDecodeError) Error() string

+ func (e *WSDecodeError) MessageType() string

+ func (e *WSDecodeError) Unwrap() error

+ type WSHandler struct

+ func WSOnDecodeError[State any](fn func(sender *WSSender, state State, err *WSDecodeError)) WSHandler[State]

+ func WSOnUnknownMessage[State any](fn func(sender *WSSender, state State, msgType string, data json.RawMessage)) WSHandler[State]

+ func WSOn[State, Msg any](name string, fn func(sender *WSSender, state State, msg Msg) error) WSHandler[State]

+ type WSMessageVariant interface

+ func WSMessageType[T any](name string) WSMessageVariant

+ type WSMessages struct

+ func Websocket[In, State any](setup func(r *http.Request, sender *WSSender, in In) (State, error), ...) *WSMessages[In]

+ type WSOption interface

+ type WSSender struct

+ func (ws *WSSender) Close(status WSStatusCode, reason string) error

+ func (ws *WSSender) Context() context.Context

+ func (ws *WSSender) Send(v any) error

+ type WSSends []WSMessageVariant

+ type WSStatusCode int

+ const WSStatusGoingAway

+ const WSStatusInternalError

+ const WSStatusNormalClosure

+ const WSStatusProtocolError

+ const WSStatusUnsupportedData

+ func WSCloseStatus(err error) WSStatusCode

Mar 9, 2026

Changes in this version

+ func FromContext[T any](r *http.Request, key *ContextKey[T]) (T, bool)

+ func HandleRaw[In any](router Router, pattern string, fn RawHandlerFunc[In], options ...RouteOption)

+ func Handle[In, Resp any](router Router, pattern string, fn HandlerFunc[In, Resp], ...)

+ func SetContext[T any](r *http.Request, key *ContextKey[T], val T) *http.Request

+ func WithContentType(contentType string, opts ...ResponseSchemaOption) routeOptionFunc

+ func WithEnum[T Scalar](values ...T) apiOptionFunc

+ type ContextKey struct

+ func NewContextKey[T any](name string) *ContextKey[T]

+ func (k *ContextKey[T]) String() string

+ type RawHandlerFunc func(w http.ResponseWriter, r *http.Request, in In) error

+ type ResponseSchemaOption struct

+ func ResponseSchema[T any]() ResponseSchemaOption

+ type Scalar interface

Mar 9, 2026

Changes in this version

type Option

+ func WithResponseHeader(name, value string) Option

Mar 8, 2026

Changes in this version

+ func WithBadRequestError[T any](fn func(error) T) apiOptionFunc

+ func WithInternalServerError[T any](fn func(error) T) apiOptionFunc

type API

+ func (a *API) Group(prefix string, opts ...GroupOption) *Group

+ type APIOption interface

+ func ComposeAPIOptions(opts ...APIOption) APIOption

+ type Group struct

+ func (g *Group) Group(prefix string, opts ...GroupOption) *Group

+ type GroupOption interface

+ func ComposeGroupOptions(opts ...GroupOption) GroupOption

type Option

+ func ComposeOptions(opts ...Option) Option

+ func WithError[T error](status int) Option

+ func WithMiddleware(mw ...func(http.Handler) http.Handler) Option

type RouteOption

+ func ComposeRouteOptions(opts ...RouteOption) RouteOption

+ type Router interface

Mar 4, 2026

Changes in this version

type Option

+ func WithMaxUploadSize(size int64) Option

Feb 16, 2026

Changes in this version

+ func Connect[Body, Resp any](api *API, path string, fn HandlerFuncWithBody[Body, Resp], ...)

+ func Delete[Resp any](api *API, path string, fn HandlerFunc[Resp], options ...RouteOption)

+ func Get[Resp any](api *API, path string, fn HandlerFunc[Resp], options ...RouteOption)

+ func Head[Resp any](api *API, path string, fn HandlerFunc[Resp], options ...RouteOption)

+ func ListenAndServe(addr string, api *API) error

+ func Options[Resp any](api *API, path string, fn HandlerFunc[Resp], options ...RouteOption)

+ func Patch[Body, Resp any](api *API, path string, fn HandlerFuncWithBody[Body, Resp], ...)

+ func Post[Body, Resp any](api *API, path string, fn HandlerFuncWithBody[Body, Resp], ...)

+ func Put[Body, Resp any](api *API, path string, fn HandlerFuncWithBody[Body, Resp], ...)

+ func Trace[Resp any](api *API, path string, fn HandlerFunc[Resp], options ...RouteOption)

+ type API struct

+ func New(options ...Option) *API

+ func (a *API) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (a *API) Spec() *openapi3.T

+ type APIError struct

+ Message string

+ Status int

+ func Error(status int, message string) *APIError

+ func (e *APIError) Error() string

+ type Contact struct

+ Email string

+ Name string

+ URL string

+ type ExternalDocs struct

+ Description string

+ URL string

+ type FieldError struct

+ Field string

+ Message string

+ type HandlerFunc func(r *http.Request) (Resp, error)

+ type HandlerFuncWithBody func(r *http.Request, body Body) (Resp, error)

+ type Info struct

+ Contact *Contact

+ Description string

+ License *License

+ Summary string

+ TermsOfService string

+ Title string

+ Version string

+ type License struct

+ Identifier string

+ Name string

+ URL string

+ type Option func(*API)

+ func WithExternalDocs(docs ExternalDocs) Option

+ func WithInfo(info Info) Option

+ func WithValidator(v *validator.Validate) Option

+ type RouteInfo struct

+ Description string

+ Summary string

+ Tags []string

+ type RouteOption func(*routeConfig)

+ func WithRouteInfo(info RouteInfo) RouteOption

+ func WithStatus(status int) RouteOption

+ type ValidationError struct

+ Errors []FieldError

+ Message string

+ func (e *ValidationError) Error() string