server

Documentation

Index

• func InCtxMiddleware(key string, value interface{}) func(http.Handler) http.Handler
• func New(options ...Option) *mux
• type Middleware
• type Option
  • func WithHost(host string) Option
  • func WithPort(port string) Option
• type Router

Functions

func InCtxMiddleware

func InCtxMiddleware(key string, value interface{}) func(http.Handler) http.Handler

InCtxMiddleware allows to specify a key/value that should be set on each request context. This is useful for services that could be used by the handlers.

func New

func New(options ...Option) *mux

New creates a new server with the given options and default middleware.

Types

type Middleware

type Middleware func(http.Handler) http.Handler

Middleware is a function that receives a http.Handler and returns a http.Handler that can be used to wrap the original handler with some functionality.

type Option

type Option func(*mux)

Options for the server

func WithHost

func WithHost(host string) Option

WithHost allows to specify the host to run the server at if not specified it defaults to 0.0.0.0

func WithPort

func WithPort(port string) Option

WithPort allows to specify the port to run the server at when not specified it defaults to 3000

type Router

type Router interface {
	// Use allows to specify a middleware that should be executed for all the handlers
	Use(middleware ...Middleware)

	// Handle allows to register a new handler for a specific pattern
	Handle(pattern string, handler http.Handler)

	// HandleFunc allows to register a new handler function for a specific pattern
	HandleFunc(pattern string, handler http.HandlerFunc)

	// Folder allows to serve static files from a directory
	Folder(prefix string, fs fs.FS)

	// Group allows to create a new group of routes with a common prefix
	Group(prefix string, fn func(Router))
}

Router is the interface that wraps the basic methods for a router