httptransport

Documentation

Index

• func NewHandler[Request any, Response any](op operation.Operation[Request, Response], ...) http.Handler
• type ErrorEncoder
• type ErrorHandler
• type HandlerOption
  • func WithErrorHandler(errorHandler ErrorHandler) HandlerOption
  • func WithOperationName(name string) HandlerOption
  • func WithOperationNameFunc(fn func(ctx context.Context) string) HandlerOption
• type RequestDecoder
• type ResponseEncoder

Functions

func NewHandler

func NewHandler[Request any, Response any](
	op operation.Operation[Request, Response],
	requestDecoder RequestDecoder[Request],
	responseEncoder ResponseEncoder[Response],
	errorEncoder ErrorEncoder,
	options ...HandlerOption,
) http.Handler

NewHandler returns a new HTTP handler that wraps the given operation.Operation.

Types

type ErrorEncoder

type ErrorEncoder func(ctx context.Context, err error, w http.ResponseWriter) bool

ErrorEncoder is responsible for encoding an error to the ResponseWriter. Users are encouraged to use custom ErrorEncoders to encode HTTP errors to their clients, and will likely want to pass and check for their own error types. See the example shipping/handling service.

type ErrorHandler

type ErrorHandler interface {
	Handle(ctx context.Context, err error)
}

ErrorHandler receives a transport error to be processed for diagnostic purposes. Usually this means logging the error.

type HandlerOption

type HandlerOption interface {
	// contains filtered or unexported methods
}

func WithErrorHandler

func WithErrorHandler(errorHandler ErrorHandler) HandlerOption

func WithOperationName

func WithOperationName(name string) HandlerOption

func WithOperationNameFunc

func WithOperationNameFunc(fn func(ctx context.Context) string) HandlerOption

type RequestDecoder

type RequestDecoder[Request any] func(ctx context.Context, r *http.Request) (Request, error)

type ResponseEncoder

type ResponseEncoder[Response any] func(ctx context.Context, w http.ResponseWriter, response Response) error