web

Documentation

Index

• func Decode(w http.ResponseWriter, r *http.Request, val interface{}) error
• func Param(r *http.Request, key string) string
• func Respond(ctx context.Context, w http.ResponseWriter, data interface{}, statusCode int) error
• type Handler
  • func WrapMiddleware(mw []Middleware, handler Handler) Handler
• type Middleware

Functions

func Decode

func Decode(w http.ResponseWriter, r *http.Request, val interface{}) error

Decode reads the body of an HTTP request looking for a JSON document. The body is decoded into the provided value.

If the provided value is a struct then it is checked for validation tags.

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, data interface{}, statusCode int) error

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

Types

type Handler

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

A Handler is a type that handles a http request, it differs from http.Handler because it returns an error and the context is explicitly passed.

func WrapMiddleware

func WrapMiddleware(mw []Middleware, handler Handler) Handler

WrapMiddleware creates a new handler by wrapping middleware around a final handler. The middlewares' Handlers will be executed by requests in the order they are provided.

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.