README
¶
Mux
a small idomatic http router and request multiplexer for go.
Overview
provides a clean, expressive way to route HTTP requests in Go applications.
- Route matching by path, host, query, headers, methods, and schemes
- Subrouters with shared conditions (prefix, middleware grouping)
- Middleware support (CORS, auth, logging, etc.)
- Static file serving and SPA-friendly routing
Prerequisites
go version 1.23
Running
Basic Example
package main
import (
"fmt"
"net/http"
"github.com/devilcove/mux"
)
func main() {
r := mux.NewRouter()
r.Get("/{$}", homeHandler)
r.Get("/articles/{id}", articleHandler)
// Serve static assets
r.Static("/static", static)
r.Run(":8000")
}
func homeHandler(w http.ResponseWriter, r *http.Request) {
fmt.Fprintln(w, "Welcome to mux-powered app!")
}
func articleHandler(w http.ResponseWriter, r *http.Request) {
id := r.PathValue("id")
fmt.Fprintf(w, "Article ID: %s\n", id)
}
Documentation
¶
Overview ¶
Package mux is a small, idomatic http router
Index ¶
- func Logger(next http.Handler) http.Handler
- type Middleware
- type Router
- func (router *Router) All(pattern string, handler http.HandlerFunc)
- func (router *Router) Delete(pattern string, handler http.HandlerFunc)
- func (router *Router) Get(pattern string, handler http.HandlerFunc)
- func (router *Router) Group(prefix string, middlewares ...Middleware) *Router
- func (router *Router) Patch(pattern string, handler http.HandlerFunc)
- func (router *Router) Post(pattern string, handler http.HandlerFunc)
- func (router *Router) Put(pattern string, handler http.HandlerFunc)
- func (router *Router) Run(addr string)
- func (router *Router) ServeFile(pattern, file string)
- func (router *Router) ServeHTTP(w http.ResponseWriter, r *http.Request)
- func (router *Router) Static(pattern, dir string)
- func (router *Router) Use(middlewares ...Middleware)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Middleware ¶
Middleware defines a function that wraps an http.Handler.
type Router ¶
Router provides a chain of middlewares and routes.
func DefaultRouter ¶
func DefaultRouter() *Router
DefaultRouter creates a new Router using the default ServeMux.
func NewRouter ¶
func NewRouter(middleware ...Middleware) *Router
NewRouter creates a new Router with the given middleware applied.
func (*Router) All ¶
func (router *Router) All(pattern string, handler http.HandlerFunc)
All registers the handler for all methods on given pattern.
func (*Router) Delete ¶
func (router *Router) Delete(pattern string, handler http.HandlerFunc)
Delete registers the handler for delete requests on given pattern.
func (*Router) Get ¶
func (router *Router) Get(pattern string, handler http.HandlerFunc)
Get registers the handler for get requests on given pattern.
func (*Router) Group ¶
func (router *Router) Group(prefix string, middlewares ...Middleware) *Router
Group creates a sub-router for the given prefix and applies middleware to it.
func (*Router) Patch ¶
func (router *Router) Patch(pattern string, handler http.HandlerFunc)
Delete registers the handler for patch requests on given pattern.
func (*Router) Post ¶
func (router *Router) Post(pattern string, handler http.HandlerFunc)
Post registers the handler for post requests on given pattern.
func (*Router) Put ¶
func (router *Router) Put(pattern string, handler http.HandlerFunc)
Put registers the handler for Put requests on given pattern.
func (*Router) ServeHTTP ¶
func (router *Router) ServeHTTP(w http.ResponseWriter, r *http.Request)
ServeHTTP implements the http.Handler interface.
func (*Router) Use ¶
func (router *Router) Use(middlewares ...Middleware)
Use adds a chain of middlewares to the router.
Source Files
Directories