router

Documentation

Index

• type Attr
  • func ToAttrs(params []any) ([]*Attr, error)
• type Middleware
• type MiddlewareFunc
  • func (f MiddlewareFunc) Middleware(next http.Handler) http.Handler
• type Route
  • func (r *Route) GetMiddleware() []Middleware
  • func (r *Route) Name(name string) *Route
• type Router
  • func New() *Router
  • func (r *Router) Delete(path string, handler http.Handler) *Route
  • func (r *Router) Get(path string, handler http.Handler) *Route
  • func (r *Router) Group(prefix string, cb func(r *Router))
  • func (r *Router) Handle(p string, handler http.Handler) *Route
  • func (r *Router) Patch(path string, handler http.Handler) *Route
  • func (r *Router) Paths(ctx context.Context, basePath string) (*spec.Paths, error)
  • func (r *Router) Post(path string, handler http.Handler) *Route
  • func (r *Router) PrintRoutes()
  • func (r *Router) Put(path string, handler http.Handler) *Route
  • func (r *Router) Register(ctx context.Context)
  • func (r *Router) Routes() []*Route
  • func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request)
  • func (r *Router) Use(middleware Middleware)
  • func (r *Router) UseFunc(middleware func(http.Handler) http.Handler)
  • func (r *Router) Validate(ctx context.Context) error
• type SalusaResolver
  • func NewResolver(origin string, r *Router) *SalusaResolver
  • func (r *SalusaResolver) Resolve(name string, params ...any) string
  • func (r *SalusaResolver) ResolveHandler(h http.Handler, params ...any) string
• type URLResolver

Examples

• Router

Types

type Attr

type Attr struct {
	Key   string
	Value string
}

func ToAttrs

func ToAttrs(params []any) ([]*Attr, error)

type Middleware

type Middleware interface {
	Middleware(next http.Handler) http.Handler
}

type MiddlewareFunc

type MiddlewareFunc func(http.Handler) http.Handler

func (MiddlewareFunc) Middleware

func (f MiddlewareFunc) Middleware(next http.Handler) http.Handler

type Route

type Route struct {
	Path   string
	Method string
	// contains filtered or unexported fields
}

func (*Route) GetMiddleware

func (r *Route) GetMiddleware() []Middleware

func (*Route) Name

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

type Router

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

Example

package main

import (
	"github.com/abibby/salusa/request"
	"github.com/abibby/salusa/router"
)

func main() {
	r := router.New()

	r.Group("/test", func(r *router.Router) {
		r.Get("/", request.Handler(func(r *any) (any, error) {
			return nil, nil
		}))
	})
}

func New

func New() *Router

func (*Router) Delete

func (r *Router) Delete(path string, handler http.Handler) *Route

func (*Router) Get

func (r *Router) Get(path string, handler http.Handler) *Route

func (*Router) Group

func (r *Router) Group(prefix string, cb func(r *Router))

func (*Router) Handle

func (r *Router) Handle(p string, handler http.Handler) *Route

func (*Router) Patch

func (r *Router) Patch(path string, handler http.Handler) *Route

func (*Router) Paths

func (r *Router) Paths(ctx context.Context, basePath string) (*spec.Paths, error)

func (*Router) Post

func (r *Router) Post(path string, handler http.Handler) *Route

func (*Router) PrintRoutes

func (r *Router) PrintRoutes()

func (*Router) Put

func (r *Router) Put(path string, handler http.Handler) *Route

func (*Router) Register

func (r *Router) Register(ctx context.Context)

func (*Router) Routes

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

func (*Router) ServeHTTP

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

func (*Router) Use

func (r *Router) Use(middleware Middleware)

func (*Router) UseFunc

func (r *Router) UseFunc(middleware func(http.Handler) http.Handler)

func (*Router) Validate

func (r *Router) Validate(ctx context.Context) error

type SalusaResolver

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

func NewResolver

func NewResolver(origin string, r *Router) *SalusaResolver

func (*SalusaResolver) Resolve

func (r *SalusaResolver) Resolve(name string, params ...any) string

func (*SalusaResolver) ResolveHandler

func (r *SalusaResolver) ResolveHandler(h http.Handler, params ...any) string

type URLResolver

type URLResolver interface {
	Resolve(name string, params ...any) string
	ResolveHandler(h http.Handler, params ...any) string
}