README
¶
Mux - A Lightweight HTTP Router for Go
Mux is a simple, lightweight HTTP router for Go that wraps around the standard http.ServeMux to provide additional functionality and a more ergonomic API.
Features
- HTTP method-specific routing (GET, POST, PUT, DELETE, etc.)
- Middleware support with flexible stacking
- Route grouping for organization and shared middleware
- RESTful resource routing
- URL parameter extraction
- Graceful shutdown support
- Minimal dependencies (only uses Go standard library)
Installation
go get code.patial.tech/go/mux
Basic Usage
package main
import (
"fmt"
"net/http"
"code.patial.tech/go/mux"
)
func main() {
// Create a new router
router := mux.NewRouter()
// Define a simple route
router.GET("/", func(w http.ResponseWriter, r *http.Request) {
fmt.Fprint(w, "Hello, World!")
})
// Start the server
http.ListenAndServe(":8080", router)
}
Routing
Mux supports all HTTP methods defined in the Go standard library:
router.GET("/users", listUsers)
router.POST("/users", createUser)
router.PUT("/users/{id}", updateUser)
router.DELETE("/users/{id}", deleteUser)
router.PATCH("/users/{id}", partialUpdateUser)
router.HEAD("/users", headUsers)
router.OPTIONS("/users", optionsUsers)
router.TRACE("/users", traceUsers)
router.CONNECT("/users", connectUsers)
URL Parameters
Mux supports URL parameters using curly braces:
router.GET("/users/{id}", func(w http.ResponseWriter, r *http.Request) {
id := r.PathValue("id")
fmt.Fprintf(w, "User ID: %s", id)
})
Middleware
Middleware functions take an http.Handler and return an http.Handler. You can add global middleware to all routes:
// Logging middleware
func loggingMiddleware(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Printf("[%s] %s\n", r.Method, r.URL.Path)
next.ServeHTTP(w, r)
})
}
// Add middleware to all routes
router.Use(loggingMiddleware)
Route Groups
Group related routes and apply middleware to specific groups:
// API routes group
router.Group(func(api *mux.Router) {
// Middleware only for API routes
api.Use(authMiddleware)
// API routes
api.GET("/api/users", listUsers)
api.POST("/api/users", createUser)
})
RESTful Resources
Easily define RESTful resources:
router.Resource("/posts", func(r *mux.Resource) {
r.Index(listPosts) // GET /posts
r.Show(showPost) // GET /posts/{id}
r.Create(createPost) // POST /posts
r.Update(updatePost) // PUT /posts/{id}
r.Destroy(deletePost) // DELETE /posts/{id}
r.New(newPostForm) // GET /posts/new
})
Graceful Shutdown
Use the built-in graceful shutdown functionality:
router.Serve(func(srv *http.Server) error {
srv.Addr = ":8080"
return srv.ListenAndServe()
})
Custom 404 Handler
can be tried like this
router.GET("/", func(writer http.ResponseWriter, request *http.Request) {
if request.URL.Path != "/" {
writer.WriteHeader(404)
writer.Write([]byte(`not found, da xiong dei !!!`))
return
}
})
Full Example
See the examples directory for complete working examples.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Documentation
¶
Index ¶
- type Mux
- func (m *Mux) CONNECT(pattern string, h http.HandlerFunc)
- func (m *Mux) DELETE(pattern string, h http.HandlerFunc, mw ...func(http.Handler) http.Handler)
- func (m *Mux) GET(pattern string, h http.HandlerFunc, mw ...func(http.Handler) http.Handler)
- func (m *Mux) Group(fn func(grp *Mux))
- func (m *Mux) HEAD(pattern string, h http.HandlerFunc, mw ...func(http.Handler) http.Handler)
- func (m *Mux) HttpServeMux() *http.ServeMux
- func (m *Mux) OPTIONS(pattern string, h http.HandlerFunc)
- func (m *Mux) PATCH(pattern string, h http.HandlerFunc, mw ...func(http.Handler) http.Handler)
- func (m *Mux) POST(pattern string, h http.HandlerFunc, mw ...func(http.Handler) http.Handler)
- func (m *Mux) PUT(pattern string, h http.HandlerFunc, mw ...func(http.Handler) http.Handler)
- func (m *Mux) PrintRoutes(w io.Writer)
- func (m *Mux) Resource(pattern string, fn func(res *Resource), mw ...func(http.Handler) http.Handler)
- func (m *Mux) RouteList() []string
- func (m *Mux) Serve(cb ServeCB)
- func (m *Mux) ServeHTTP(w http.ResponseWriter, req *http.Request)
- func (m *Mux) TRACE(pattern string, h http.HandlerFunc)
- func (m *Mux) Use(h ...func(http.Handler) http.Handler)
- func (m *Mux) With(mw ...func(http.Handler) http.Handler) *Mux
- type Resource
- func (res *Resource) Create(h http.HandlerFunc)
- func (res *Resource) CreateView(h http.HandlerFunc)
- func (res *Resource) Delete(h http.HandlerFunc)
- func (res *Resource) HandleDELETE(pattern string, h http.HandlerFunc)
- func (res *Resource) HandleGET(pattern string, h http.HandlerFunc)
- func (res *Resource) HandlePATCH(pattern string, h http.HandlerFunc)
- func (res *Resource) HandlePOST(pattern string, h http.HandlerFunc)
- func (res *Resource) HandlePUT(pattern string, h http.HandlerFunc)
- func (res *Resource) Index(h http.HandlerFunc)
- func (res *Resource) Update(h http.HandlerFunc)
- func (res *Resource) UpdatePartial(h http.HandlerFunc)
- func (res *Resource) Use(middlewares ...func(http.Handler) http.Handler)
- func (res *Resource) View(h http.HandlerFunc)
- type RouteList
- type ServeCB
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Mux ¶ added in v0.5.0
Mux is a wrapper around the go's standard http.ServeMux. It's a lean wrapper with methods to make routing easier
func (*Mux) CONNECT ¶ added in v0.5.0
func (m *Mux) CONNECT(pattern string, h http.HandlerFunc)
CONNECT method route
func (*Mux) Group ¶ added in v0.5.0
Group adds a new inline-Router along the current routing path, with a fresh middleware stack for the inline-Router.
func (*Mux) HttpServeMux ¶ added in v0.5.0
HttpServeMux DO NOT USE it for routing, exposed only for edge cases.
func (*Mux) OPTIONS ¶ added in v0.5.0
func (m *Mux) OPTIONS(pattern string, h http.HandlerFunc)
OPTIONS method route
func (*Mux) PrintRoutes ¶ added in v0.5.0
func (*Mux) Resource ¶ added in v0.5.0
func (m *Mux) Resource(pattern string, fn func(res *Resource), mw ...func(http.Handler) http.Handler)
Resource routes mapping by using HTTP verbs
- GET /pattern view all resources
- GET /pattern/create new resource view
- POST /pattern create a new resource
- GET /pattern/:id view a resource
- PUT /pattern/:id update a resource
- PATCH /pattern/:id partial update a resource
- DELETE /resource/:id delete a resource
func (*Mux) ServeHTTP ¶ added in v0.5.0
func (m *Mux) ServeHTTP(w http.ResponseWriter, req *http.Request)
func (*Mux) TRACE ¶ added in v0.5.0
func (m *Mux) TRACE(pattern string, h http.HandlerFunc)
TRACE method route
type Resource ¶
type Resource struct {
// contains filtered or unexported fields
}
func (*Resource) Create ¶
func (res *Resource) Create(h http.HandlerFunc)
Create a new resource
POST /pattern/create
func (*Resource) CreateView ¶ added in v0.5.0
func (res *Resource) CreateView(h http.HandlerFunc)
CreateView new resource
GET /pattern/create
func (*Resource) Delete ¶ added in v0.5.0
func (res *Resource) Delete(h http.HandlerFunc)
Delete a resource
DELETE /pattern/:id
func (*Resource) HandleDELETE ¶ added in v0.7.1
func (res *Resource) HandleDELETE(pattern string, h http.HandlerFunc)
HandleDELETE on /group-pattern/:id/pattern
func (*Resource) HandleGET ¶ added in v0.7.1
func (res *Resource) HandleGET(pattern string, h http.HandlerFunc)
HandleGET on /group-pattern/:id/pattern
func (*Resource) HandlePATCH ¶ added in v0.7.1
func (res *Resource) HandlePATCH(pattern string, h http.HandlerFunc)
HandlePATCH on /group-pattern/:id/pattern
func (*Resource) HandlePOST ¶ added in v0.7.1
func (res *Resource) HandlePOST(pattern string, h http.HandlerFunc)
HandlePOST on /group-pattern/:id/pattern
func (*Resource) HandlePUT ¶ added in v0.7.1
func (res *Resource) HandlePUT(pattern string, h http.HandlerFunc)
HandlePUT on /group-pattern/:id/pattern
func (*Resource) Index ¶
func (res *Resource) Index(h http.HandlerFunc)
Index of all resource.
GET /pattern
func (*Resource) Update ¶
func (res *Resource) Update(h http.HandlerFunc)
Update a resource
PUT /pattern/:id
func (*Resource) UpdatePartial ¶ added in v0.5.0
func (res *Resource) UpdatePartial(h http.HandlerFunc)
UpdatePartial resource info PATCH /pattern/:id
func (*Resource) View ¶ added in v0.5.0
func (res *Resource) View(h http.HandlerFunc)
View a resource
GET /pattern/:id
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.