web

Documentation

Overview

Package web contains a small web framework extension.

Index

• func Decode(r *http.Request, v Decoder) error
• func GetWriter(ctx context.Context) http.ResponseWriter
• func Param(r *http.Request, key string) string
• func Respond(ctx context.Context, w http.ResponseWriter, dataModel Encoder) error
• type App
  • func NewApp(log Logger, tracer trace.Tracer, mw ...MidFunc) *App
  • func (a *App) EnableCORS(origins []string)
  • func (a *App) FileServer(static embed.FS, dir string, path string) error
  • func (a *App) FileServerReact(static embed.FS, dir string, path string) error
  • func (a *App) HandlerFunc(method string, group string, path string, handlerFunc HandlerFunc, ...)
  • func (a *App) HandlerFuncNoMid(method string, group string, path string, handlerFunc HandlerFunc)
  • func (a *App) RawHandlerFunc(method string, group string, path string, rawHandlerFunc http.HandlerFunc, ...)
  • func (a *App) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Decoder
• type Encoder
• type HandlerFunc
• type Logger
• type MidFunc
• type NoResponse
  • func NewNoResponse() NoResponse
  • func (NoResponse) Encode() ([]byte, string, error)

Functions

func Decode

func Decode(r *http.Request, v Decoder) error

Decode reads the body of an HTTP request and decodes the body into the specified data model. If the data model implements the validator interface, the method will be called.

func GetWriter

func GetWriter(ctx context.Context) http.ResponseWriter

GetWriter returns the underlying writer for the request.

func Param

func Param(r *http.Request, key string) string

Param returns the web call parameters from the request.

func Respond

func Respond(ctx context.Context, w http.ResponseWriter, dataModel Encoder) error

Respond sends a response to the client.

Types

type App

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

App is the entrypoint into our application and what configures our context object for each of our http handlers. Feel free to add any configuration data/logic on this App struct.

func NewApp

func NewApp(log Logger, tracer trace.Tracer, mw ...MidFunc) *App

NewApp creates an App value that handle a set of routes for the application.

func (*App) EnableCORS

func (a *App) EnableCORS(origins []string)

EnableCORS enables CORS preflight requests to work in the middleware. It prevents the MethodNotAllowedHandler from being called. This must be enabled for the CORS middleware to work.

func (*App) FileServer

func (a *App) FileServer(static embed.FS, dir string, path string) error

FileServer starts a file server based on the specified file system and directory inside that file system.

func (*App) FileServerReact

func (a *App) FileServerReact(static embed.FS, dir string, path string) error

FileServerReact starts a file server based on the specified file system and directory inside that file system for a statically built react webapp.

func (*App) HandlerFunc

func (a *App) HandlerFunc(method string, group string, path string, handlerFunc HandlerFunc, mw ...MidFunc)

HandlerFunc sets a handler function for a given HTTP method and path pair to the application server mux.

func (*App) HandlerFuncNoMid

func (a *App) HandlerFuncNoMid(method string, group string, path string, handlerFunc HandlerFunc)

HandlerFuncNoMid sets a handler function for a given HTTP method and path pair to the application server mux. Does not include the application middleware or OTEL tracing.

func (*App) RawHandlerFunc

func (a *App) RawHandlerFunc(method string, group string, path string, rawHandlerFunc http.HandlerFunc, mw ...MidFunc)

RawHandlerFunc sets a raw handler function for a given HTTP method and path pair to the application server mux.

func (*App) ServeHTTP

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

ServeHTTP implements the http.Handler interface. It's the entry point for all http traffic and allows the opentelemetry mux to run first to handle tracing. The opentelemetry mux then calls the application mux to handle application traffic. This was set up in the NewApp function.

type Decoder

type Decoder interface {
	Decode(data []byte) error
}

Decoder represents data that can be decoded.

type Encoder

type Encoder interface {
	Encode() (data []byte, contentType string, err error)
}

Encoder defines behavior that can encode a data model and provide the content type for that encoding.

type HandlerFunc

type HandlerFunc func(ctx context.Context, r *http.Request) Encoder

HandlerFunc represents a function that handles a http request within our own little mini framework.

type Logger

type Logger func(ctx context.Context, msg string, args ...any)

Logger represents a function that will be called to add information to the logs.

type MidFunc

type MidFunc func(handler HandlerFunc) HandlerFunc

MidFunc is a handler function designed to run code before and/or after another Handler. It is designed to remove boilerplate or other concerns not direct to any given app Handler.

type NoResponse

type NoResponse struct{}

NoResponse tells the Respond function to not respond to the request. In these cases the app layer code has already done so.

func NewNoResponse

func NewNoResponse() NoResponse

NewNoResponse constructs a no reponse value.

func (NoResponse) Encode

func (NoResponse) Encode() ([]byte, string, error)

Encode implements the Encoder interface