Documentation
¶
Index ¶
- func GetValidatedInput[T any](e *core.RequestEvent) (T, error)
- func RegisterRoutesWithValidation(app core.App, group *router.RouterGroup[*core.RequestEvent], ...)
- func RegisterRoutesWithoutValidation(app core.App, group *router.RouterGroup[*core.RequestEvent], ...)
- type HandlerFactory
- type HandlerFunc
- type QuerySearchAttribute
- type RouteDefinition
- type RouteGroup
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 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)
Click to show internal directories.
Click to hide internal directories.