router

This package comes with a nicer to use API for the newly introduced routing enhancements in the Go 1.22 release. It adds the following features:

• It allows you to use HTTP methods as functions rather than it being part of the URL path.
• It allows you to group routes under a common prefix.
• It allows you to add middlewares to the router itself, single routes and route groups.

Usage

Creating a new router

To create a new router, use the NewRouter function.

r := router.NewRouter()

Setting a custom router config

The router by default adds a "{$}" to the end of each route, it also adds a trailing slash to each route. This is done because the behaviour of Go's pattern matching is a bit weird (read about it here) and can result in unexpected behavior. In my opinion, this way it's doing what most people would expect it to do.

However, if you want, you can disable both behavours by setting a custom router config. I'd suggest doing this only if you have worked with the default router (mux) from the standard library and understand the behaviour.

To set a custom router config, use the SetConfig method.

r := router.NewRouter()
r.SetConfig(router.RouterConfig{
	DisableAutoAddExactMatchWildcard: true,
	DisableAutoAddTrailingSlash:      true,
})

Set custom mux to the router

If you want to use a custom mux, you can set it using the SetMux method.

r.SetMux(http.NewServeMux())

Adding routes

You can add add routes in two ways; Single routes, or grouped routes.

Note: Some routers require adding leading slashes, some don't, some require adding trailing slashes, some don't. With this router, you can do either and the final generated path will be so the Go http package can understand it.

Single routes

r := router.NewRouter()

r.GET("/get-endpoint", func(w http.ResponseWriter, r *http.Request) {
	w.Write([]byte("Hello, World!"))
})

r.POST("/post-endpoint", func(w http.ResponseWriter, r *http.Request) {
	w.Write([]byte("You did a post request!"))
})

r.PUT("/put-endpoint", func(w http.ResponseWriter, r *http.Request) {
	w.Write([]byte("You did a put request!"))
})

r.PATCH("/patch-endpoint", func(w http.ResponseWriter, r *http.Request) {
	w.Write([]byte("You did a patch request!"))
})

r.DELETE("/delete-endpoint", func(w http.ResponseWriter, r *http.Request) {
	w.Write([]byte("You did a delete request!"))
})

r.OPTIONS("/options-endpoint", func(w http.ResponseWriter, r *http.Request) {
	w.Write([]byte("You did an options request!"))
})

r.HEAD("/head-endpoint", func(w http.ResponseWriter, r *http.Request) {
	w.Write([]byte("You did a head request!"))
})

r.CONNECT("/connect-endpoint", func(w http.ResponseWriter, r *http.Request) {
	w.Write([]byte("You did a connect request!"))
})

r.TRACE("/trace-endpoint", func(w http.ResponseWriter, r *http.Request) {
	w.Write([]byte("You did a trace request!"))
})

Grouped routes

You can group routes under a common prefix using the Group method.

r := router.NewRouter()
r.Group("grouped", func(rg *router.Router) {
	rg.GET("/get", func(w http.ResponseWriter, r *http.Request) {
		w.Write([]byte("Hello, World!"))
	})
	rg.POST("/post", func(w http.ResponseWriter, r *http.Request) {
		w.Write([]byte("You did a post request!"))
	})
})

r.Group("multi/level/group", func(rg *router.Router) {
	rg.GET("/get", func(w http.ResponseWriter, r *http.Request) {
		w.Write([]byte("Hello, World!"))
	})
	rg.POST("/post", func(w http.ResponseWriter, r *http.Request) {
		w.Write([]byte("You did a post request!"))
	})
})

The above will create the following routes, /group/get/, /group/post/, /multi/level/group/get/ and multi/level/group/get/.

Middlewares

You can add middlewares to router itself, single routes and route groups using the Use method.

r := router.NewRouter()

// Define middleware functions
XTestGlobalMiddleware := func(next http.HandlerFunc) http.HandlerFunc {
	return func(w http.ResponseWriter, r *http.Request) {
		w.Header().Set("X-Test-Global-Middleware", "This header is set from the global middleware!")
		next.ServeHTTP(w, r)
	}
}
XTestSingleHeaderMiddleware := func(next http.HandlerFunc) http.HandlerFunc {
	return func(w http.ResponseWriter, r *http.Request) {
		w.Header().Set("X-Test-Single-Header", "This header is set from the single route middleware!")
		next.ServeHTTP(w, r)
	}
}
XTestGroupHeaderMiddleware := func(next http.HandlerFunc) http.HandlerFunc {
	return func(w http.ResponseWriter, r *http.Request) {
		w.Header().Set("X-Test-Group-Header", "This header is set from the route group middleware!")
		next.ServeHTTP(w, r)
	}
}

// Adding middleware to the router itself
r.Use(XTestGlobalMiddleware)

// Adding middleware to a single route
r.GET("/get-endpoint", func(w http.ResponseWriter, r *http.Request) {
	w.Write([]byte("Hello, World!"))
}).Use(XTestSingleHeaderMiddleware)

// Adding middleware to a route group
r.Group("group", func(rg *router.Router) {
	rg.GET("/get", func(w http.ResponseWriter, r *http.Request) {
		w.Write([]byte("Hello, World!"))
	})
}).Use(XTestGroupHeaderMiddleware)

Things I'd like to add

• Host/domain matching
• Route naming (maybe?)
• ...More?