Help us shape the future of Go! Take the 2026 Go Developer Survey

router

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 16, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package router is a thin layer over net/http.ServeMux (Go 1.22+ patterns) adding route groups, named routes with URL generation, resource controllers and three middleware stacks:

  • server middleware runs on every request, even when no route matches;
  • router middleware runs only when a route matches;
  • route/group middleware runs for the routes it is attached to.

Middleware has the standard signature func(http.Handler) http.Handler, so any net/http middleware works.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Adapt 

func Adapt(h web.HandlerFunc, services *web.Services) http.Handler

Adapt converts a HandlerFunc into an http.Handler using services.

func Wrap 

func Wrap(h http.Handler) web.HandlerFunc

Wrap converts an http.Handler into a HandlerFunc.

Types

type Creator 

type Creator interface{ Create(c *web.Ctx) error }

Creator handles GET /posts/create (HTML form).

type Destroyer 

type Destroyer interface{ Destroy(c *web.Ctx) error }

Destroyer handles DELETE /posts/{post}.

type Editor 

type Editor interface{ Edit(c *web.Ctx) error }

Editor handles GET /posts/{post}/edit (HTML form).

type Group 

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

Group is a set of routes sharing a path prefix, a name prefix and middleware. Groups nest.

func (*Group) APIResource 

func (g *Group) APIResource(name string, ctrl any) *Resource

APIResource is Resource without the create and edit form routes.

func (*Group) Any 

func (g *Group) Any(path string, h web.HandlerFunc) *Route

Any registers path for every method.

func (*Group) Delete 

func (g *Group) Delete(path string, h web.HandlerFunc) *Route

Delete registers a DELETE route.

func (*Group) Get 

func (g *Group) Get(path string, h web.HandlerFunc) *Route

Get registers a GET route (it also answers HEAD).

func (*Group) Group 

func (g *Group) Group(prefix string, fn func(g *Group)) *Group

Group creates a nested group.

func (*Group) Handle 

func (g *Group) Handle(pattern string, h http.Handler) *Route

Handle mounts an http.Handler; pattern may start with a method.

func (*Group) Match 

func (g *Group) Match(methods []string, path string, h web.HandlerFunc) []*Route

Match registers path for each method.

func (*Group) Name 

func (g *Group) Name(prefix string) *Group

Name sets the name prefix of the group ("admin." makes "admin.posts.index").

func (*Group) Options 

func (g *Group) Options(path string, h web.HandlerFunc) *Route

Options registers an OPTIONS route.

func (*Group) Patch 

func (g *Group) Patch(path string, h web.HandlerFunc) *Route

Patch registers a PATCH route.

func (*Group) Post 

func (g *Group) Post(path string, h web.HandlerFunc) *Route

Post registers a POST route.

func (*Group) Put 

func (g *Group) Put(path string, h web.HandlerFunc) *Route

Put registers a PUT route.

func (*Group) Resource 

func (g *Group) Resource(name string, ctrl any) *Resource

Resource registers RESTful routes for ctrl under /name. Nested resources use dots: "posts.comments" → /posts/{post}/comments/{comment}. Route names are "<name>.<action>".

func (*Group) Use 

func (g *Group) Use(mw ...Middleware) *Group

Use appends middleware applied to every route of the group (including routes registered before the call and in nested groups).

type Indexer 

type Indexer interface{ Index(c *web.Ctx) error }

Indexer handles GET /posts.

type Middleware 

type Middleware = func(http.Handler) http.Handler

Middleware wraps an http.Handler.

type Resource 

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

Resource is a set of routes generated from a controller.

func (*Resource) Except 

func (rs *Resource) Except(actions ...string) *Resource

Except removes the named actions.

func (*Resource) Only 

func (rs *Resource) Only(actions ...string) *Resource

Only keeps the named actions and removes the others.

func (*Resource) Shallow 

func (rs *Resource) Shallow() *Resource

Shallow makes the member routes of a nested resource top-level, as their IDs are unique on their own: /posts/{post}/comments stays for index/create/store, while show/edit/update/destroy become /comments/{comment}. Route names do not change.

func (*Resource) Use 

func (rs *Resource) Use(mw ...Middleware) *Resource

Use applies middleware to the resource routes (all actions when none are given by Only/Except before).

type Route 

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

Route is a registered route.

func (*Route) FullName 

func (rt *Route) FullName() string

FullName returns the name including group prefixes, or "".

func (*Route) Name 

func (rt *Route) Name(name string) *Route

Name sets the route name used by URL generation. The names of enclosing groups are prefixed when the router is compiled.

func (*Route) Use 

func (rt *Route) Use(mw ...Middleware) *Route

Use appends route middleware.

type RouteInfo 

type RouteInfo struct {
	Method     string   `json:"method"`
	Path       string   `json:"path"`
	Name       string   `json:"name,omitempty"`
	Middleware []string `json:"middleware,omitempty"`
}

RouteInfo describes a compiled route.

type Router 

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

Router collects routes and compiles them into an http.Handler.

func New 

func New(services *web.Services) *Router

New returns an empty Router. services may be nil.

func (*Router) APIResource 

func (r *Router) APIResource(name string, ctrl any) *Resource

APIResource is Resource without the create and edit form routes.

func (*Router) Any 

func (r *Router) Any(path string, h web.HandlerFunc) *Route

Any registers a route for every method.

func (*Router) Delete 

func (r *Router) Delete(path string, h web.HandlerFunc) *Route

Delete registers a DELETE route.

func (*Router) Get 

func (r *Router) Get(path string, h web.HandlerFunc) *Route

Get registers a GET route (it also answers HEAD).

func (*Router) Group 

func (r *Router) Group(prefix string, fn func(g *Group)) *Group

Group creates a route group under prefix.

func (*Router) Handle 

func (r *Router) Handle(pattern string, h http.Handler) *Route

Handle mounts a plain http.Handler. pattern uses ServeMux syntax and may start with a method ("GET /metrics").

func (*Router) Handler 

func (r *Router) Handler() (http.Handler, error)

Handler compiles the routes. It reports pattern conflicts, invalid patterns and duplicate names. Routes added afterwards are ignored.

func (*Router) Match 

func (r *Router) Match(methods []string, path string, h web.HandlerFunc) []*Route

Match registers a route for several methods.

func (*Router) Options 

func (r *Router) Options(path string, h web.HandlerFunc) *Route

Options registers an OPTIONS route.

func (*Router) Patch 

func (r *Router) Patch(path string, h web.HandlerFunc) *Route

Patch registers a PATCH route.

func (*Router) Post 

func (r *Router) Post(path string, h web.HandlerFunc) *Route

Post registers a POST route.

func (*Router) Put 

func (r *Router) Put(path string, h web.HandlerFunc) *Route

Put registers a PUT route.

func (*Router) Resource 

func (r *Router) Resource(name string, ctrl any) *Resource

Resource registers the actions ctrl implements (see Indexer, Storer, ...).

func (*Router) Routes 

func (r *Router) Routes() []RouteInfo

Routes lists compiled routes in registration order.

func (*Router) ServeHTTP 

func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request)

ServeHTTP compiles on first use and serves; it panics on a build error, so call Handler at boot to surface errors early.

func (*Router) Services 

func (r *Router) Services() *web.Services

Services returns the shared services passed to every *web.Ctx.

func (*Router) URL 

func (r *Router) URL(name string, params ...any) (string, error)

URL implements web.URLGenerator: params are name/value pairs filling the route's {wildcards}. Missing or unknown params are errors.

func (*Router) Use 

func (r *Router) Use(mw ...Middleware)

Use appends middleware that runs for every matched route.

func (*Router) UseServer 

func (r *Router) UseServer(mw ...Middleware)

UseServer appends middleware that runs for every request.

type Shower 

type Shower interface{ Show(c *web.Ctx) error }

Shower handles GET /posts/{post}.

type Storer 

type Storer interface{ Store(c *web.Ctx) error }

Storer handles POST /posts.

type Updater 

type Updater interface{ Update(c *web.Ctx) error }

Updater handles PUT and PATCH /posts/{post}.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.