web

Documentation

Index

• func GetTraceID(ctx context.Context) string
• func Respond(ctx context.Context, w http.ResponseWriter, data any, statusCode int) error
• func SetStatusCode(ctx context.Context, statusCode int) error
• type App
  • func NewApp(shutdown chan os.Signal, mw ...Middleware) *App
  • func (a *App) Handle(method, group, path string, handler Handler, mw ...Middleware)
  • func (a *App) SignalShutdown()
• type Handler
• type Middleware
• type Values
  • func GetValues(ctx context.Context) (*Values, error)

Functions

func GetTraceID

func GetTraceID(ctx context.Context) string

GetTraceID returns the trace id from the context.

func Respond

func Respond(ctx context.Context, w http.ResponseWriter, data any, statusCode int) error

Respond converts a Go value to JSON and sends it to the client.

func SetStatusCode

func SetStatusCode(ctx context.Context, statusCode int) error

SetStatusCode sets the status code back into the context.

Types

type App

type App struct {
	*httptreemux.ContextMux
	// contains filtered or unexported fields
}

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

func NewApp

func NewApp(shutdown chan os.Signal, mw ...Middleware) *App

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

func (*App) Handle

func (a *App) Handle(method, group, path string, handler Handler, mw ...Middleware)

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

func (*App) SignalShutdown

func (a *App) SignalShutdown()

SignalShutdown is used to gracefully shut down the app when an integrity issue is identified.

type Handler

type Handler func(ctx context.Context, w http.ResponseWriter, r *http.Request) error

Handler is a type that handles a http request within out own little mux mini framework.

type Middleware

type Middleware func(Handler) Handler

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

type Values

type Values struct {
	TraceID    string
	Now        time.Time
	StatusCode int
}

Values represents state for each request.

func GetValues

func GetValues(ctx context.Context) (*Values, error)

GetValues returns the values from the contexts.