routing

package
v1.324.0 Latest Latest
Warning

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

Go to latest
Published: Nov 5, 2026 License: AGPL-3.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetValidatedInput

func GetValidatedInput[T any](e *core.RequestEvent) (T, error)

func RegisterRoutesWithValidation

func RegisterRoutesWithValidation(
	app core.App,
	group *router.RouterGroup[*core.RequestEvent],
	routes []RouteDefinition,
	needsAuth bool,
)

func RegisterRoutesWithoutValidation

func RegisterRoutesWithoutValidation(
	app core.App,
	group *router.RouterGroup[*core.RequestEvent],
	routes []RouteDefinition,
)

Types

type HandlerFactory

type HandlerFactory func() func(*core.RequestEvent) error

type HandlerFunc

type HandlerFunc func(e *core.RequestEvent) error

type QuerySearchAttribute

type QuerySearchAttribute struct {
	Name        string `json:"name"`
	Required    bool   `json:"required"`
	Description string `json:"description"`
}

type RouteDefinition

type RouteDefinition struct {
	Method                string
	Path                  string
	OperationID           string
	Handler               HandlerFactory
	RequestSchema         any
	ResponseSchema        any
	Description           string
	Summary               string
	Examples              []string
	Middlewares           []*hook.Handler[*core.RequestEvent]
	ExcludedMiddlewares   []string
	QuerySearchAttributes []QuerySearchAttribute
}

type RouteGroup

type RouteGroup struct {
	BaseURL                string
	Routes                 []RouteDefinition
	Middlewares            []*hook.Handler[*core.RequestEvent]
	AuthenticationRequired bool
}

func (*RouteGroup) Add

func (r *RouteGroup) Add(app core.App)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL