exthttp

Documentation

Overview

Package exthttp supports setup of HTTP servers to implement the *Kit contracts. To keep the resulting binary small the net/http server is used.

Index

• func GetterAsHandler[T any](handler func() T) func(w http.ResponseWriter, r *http.Request, body []byte)
• func Listen(opts ListenOpts)
• func LogRequest(next func(w http.ResponseWriter, r *http.Request, body []byte)) http.HandlerFunc
• func LogRequestWithLevel(next func(w http.ResponseWriter, r *http.Request, body []byte), ...) http.HandlerFunc
• func LogRequestWithLevelFunc(next func(w http.ResponseWriter, r *http.Request, body []byte), ...) http.HandlerFunc
• func PanicRecovery(next func(w http.ResponseWriter, r *http.Request)) http.HandlerFunc
• func RegisterHttpHandler(path string, handler func(w http.ResponseWriter, r *http.Request, body []byte))
• func RequestTimeoutHeaderAware(next func(w http.ResponseWriter, r *http.Request)) http.HandlerFunc
• func WriteBody(w http.ResponseWriter, response any)
• func WriteError(w http.ResponseWriter, err extension_kit.ExtensionError)
• type ListenOpts
• type ListenSpecification
• type LoggingHttpResponseWriter
  • func (w *LoggingHttpResponseWriter) Header() http.Header
  • func (w *LoggingHttpResponseWriter) Write(bytes []byte) (int, error)
  • func (w *LoggingHttpResponseWriter) WriteHeader(statusCode int)

Functions

func GetterAsHandler

func GetterAsHandler[T any](handler func() T) func(w http.ResponseWriter, r *http.Request, body []byte)

GetterAsHandler turns a getter function into a handler function. Typically used in combination with the RegisterHttpHandler function.

func Listen

func Listen(opts ListenOpts)

func LogRequest

func LogRequest(next func(w http.ResponseWriter, r *http.Request, body []byte)) http.HandlerFunc

func LogRequestWithLevel

func LogRequestWithLevel(next func(w http.ResponseWriter, r *http.Request, body []byte), level zerolog.Level) http.HandlerFunc

func LogRequestWithLevelFunc

func LogRequestWithLevelFunc(next func(w http.ResponseWriter, r *http.Request, body []byte), level func(r *http.Request) zerolog.Level) http.HandlerFunc

func PanicRecovery

func PanicRecovery(next func(w http.ResponseWriter, r *http.Request)) http.HandlerFunc

func RegisterHttpHandler

func RegisterHttpHandler(path string, handler func(w http.ResponseWriter, r *http.Request, body []byte))

RegisterHttpHandler registers a handler for the given path. Also adds panic recovery and request logging around the handler.

func RequestTimeoutHeaderAware

func RequestTimeoutHeaderAware(next func(w http.ResponseWriter, r *http.Request)) http.HandlerFunc

func WriteBody

func WriteBody(w http.ResponseWriter, response any)

WriteBody writes the given value as the HTTP response body as JSON with status code 200.

func WriteError

func WriteError(w http.ResponseWriter, err extension_kit.ExtensionError)

WriteError writes the error as the HTTP response body with status code 500.

Types

type ListenOpts

type ListenOpts struct {
	// Port Default port to bind to. Can be overridden through the environment variable STEADYBIT_EXTENSION_PORT.
	Port int
}

type ListenSpecification

type ListenSpecification struct {
	Port int `json:"port" split_words:"true" required:"false"`

	TlsServerCert string   `json:"tlsServerCert" split_words:"true" required:"false"`
	TlsServerKey  string   `json:"tlsServerKey" split_words:"true" required:"false"`
	TlsClientCas  []string `json:"tlsClientCas" split_words:"true" required:"false"`
}

type LoggingHttpResponseWriter

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

func (*LoggingHttpResponseWriter) Header

func (w *LoggingHttpResponseWriter) Header() http.Header

func (*LoggingHttpResponseWriter) Write

func (w *LoggingHttpResponseWriter) Write(bytes []byte) (int, error)

func (*LoggingHttpResponseWriter) WriteHeader

func (w *LoggingHttpResponseWriter) WriteHeader(statusCode int)