routing

Documentation

Overview

Package routing sends requests to handlers and process the errors.

Index

• func BadRequest(s string) error
• func BadRequestf(s string, args ...interface{}) error
• func Internal(s string) error
• func Internalf(s string, args ...interface{}) error
• func JSON(w http.ResponseWriter, reply interface{}, opts ...ReplyOption) error
• func NotFound(s string) error
• func NotFoundf(s string, args ...interface{}) error
• func Param(r *http.Request, name string) string
• func RequestFromContext(ctx context.Context) *http.Request
• func Unauthorized(s string) error
• func Unauthorizedf(s string, args ...interface{}) error
• type Handler
  • func NewHandlerFromHTTP(handler http.Handler) Handler
• type Middleware
• type ReplyOption
  • func WithStatus(statusCode int) ReplyOption
• type Router
  • func (router *Router) Delete(path string, handler Handler)
  • func (router *Router) Domain(host string, opts ...RouterOption) *Router
  • func (router *Router) Get(path string, handler Handler)
  • func (router *Router) Head(path string, handler Handler)
  • func (router *Router) Header(header, value string, opts ...RouterOption) *Router
  • func (router *Router) Options(path string, handler Handler)
  • func (router *Router) PathPrefix(path string, opts ...RouterOption) *Router
  • func (router *Router) PathPrefixHandler(pathPrefix string, handler Handler)
  • func (router *Router) Post(path string, handler Handler)
  • func (router *Router) ProxyLocalAssets(destAddress string)
  • func (router *Router) Put(path string, handler Handler)
  • func (router *Router) ServeFiles(path string, root http.FileSystem)
• type RouterOption
  • func WithCORS(opts cors.Options) RouterOption
  • func WithMiddleware(middleware Middleware) RouterOption
• type Server
  • func NewServer(opts ...ServerOption) *Server
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type ServerOption
  • func WithBetaAuth(username, password string) ServerOption
  • func WithCustom404(handler Handler) ServerOption
  • func WithCustomTimeout(timeout time.Duration) ServerOption
  • func WithSentry(dsn string) ServerOption

Functions

func BadRequest

func BadRequest(s string) error

BadRequest returns a 400 HTTP error.

func BadRequestf

func BadRequestf(s string, args ...interface{}) error

BadRequestf returns a 400 HTTP error and formats its message.

func Internal

func Internal(s string) error

Internal returns a 500 HTTP error.

func Internalf

func Internalf(s string, args ...interface{}) error

Internalf returns a 500 HTTP error and formats its message.

func JSON

func JSON(w http.ResponseWriter, reply interface{}, opts ...ReplyOption) error

func NotFound

func NotFound(s string) error

NotFound returns a 404 HTTP error.

func NotFoundf

func NotFoundf(s string, args ...interface{}) error

NotFoundf returns a 404 HTTP error and formats its message.

func Param

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

Param returns a request URL parameter value.

func RequestFromContext

func RequestFromContext(ctx context.Context) *http.Request

RequestFromContext returns the HTTP request from a context. The context must have been previously extracted from r.Context().

func Unauthorized

func Unauthorized(s string) error

Unauthorized returns a 401 HTTP error.

func Unauthorizedf

func Unauthorizedf(s string, args ...interface{}) error

Unauthorizedf returns a 401 HTTP error and formats its message.

Types

type Handler

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

Handler should be implemented by the handler functions that we want to register.

func NewHandlerFromHTTP

func NewHandlerFromHTTP(handler http.Handler) Handler

NewHandlerFromHTTP creates a new handler from a standard http.Handler.

type Middleware

type Middleware func(handler Handler) Handler

type ReplyOption

type ReplyOption func(w http.ResponseWriter)

func WithStatus

func WithStatus(statusCode int) ReplyOption

type Router

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

func (*Router) Delete

func (router *Router) Delete(path string, handler Handler)

Delete registers a new DELETE route.

func (*Router) Domain

func (router *Router) Domain(host string, opts ...RouterOption) *Router

Domain matches a hostname.

func (*Router) Get

func (router *Router) Get(path string, handler Handler)

Get registers a new GET route.

func (*Router) Head

func (router *Router) Head(path string, handler Handler)

Head registers a new HEAD route.

func (*Router) Header

func (router *Router) Header(header, value string, opts ...RouterOption) *Router

Header matches a header with a specific value. If the value is empty it will match any value as long as the header is present in the request.

func (*Router) Options

func (router *Router) Options(path string, handler Handler)

Options registers a new OPTIONS route.

func (*Router) PathPrefix

func (router *Router) PathPrefix(path string, opts ...RouterOption) *Router

PathPrefix matches a path prefix.

func (*Router) PathPrefixHandler

func (router *Router) PathPrefixHandler(pathPrefix string, handler Handler)

func (*Router) Post

func (router *Router) Post(path string, handler Handler)

Post registers a new POST route.

func (*Router) ProxyLocalAssets

func (router *Router) ProxyLocalAssets(destAddress string)

func (*Router) Put

func (router *Router) Put(path string, handler Handler)

Put registers a new PUT route.

func (*Router) ServeFiles

func (router *Router) ServeFiles(path string, root http.FileSystem)

ServeFiles register a raw net/http handler with no error checking that sends files.

type RouterOption

type RouterOption func(router *Router)

func WithCORS

func WithCORS(opts cors.Options) RouterOption

WithCORS configures a CORS middleware to authorize cross-origin requests.

func WithMiddleware

func WithMiddleware(middleware Middleware) RouterOption

WithMiddleware adds a middleware to the router.

type Server

type Server struct {
	*Router
	// contains filtered or unexported fields
}

Server configures the routing table.

func NewServer

func NewServer(opts ...ServerOption) *Server

NewServer configures a new router with the options.

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

type ServerOption

type ServerOption func(server *Server)

ServerOption is implement by any option that can be passed when constructing a new server.

func WithBetaAuth

func WithBetaAuth(username, password string) ServerOption

WithBetaAuth installs a rough authentication mechanism to avoid the final users to access beta sites.

func WithCustom404

func WithCustom404(handler Handler) ServerOption

WithCustom404 uses a custom 404 template file.

func WithCustomTimeout

func WithCustomTimeout(timeout time.Duration) ServerOption

WithCustomTimeout changes the default timeout of 29 seconds to a custom one. It's only recommended for environments where the limit is longer than 30-60 seconds. For example background queues might have 10 minutes of activity in some setups.

func WithSentry

func WithSentry(dsn string) ServerOption

WithSentry configures Sentry logging of issues in the handlers.