route

type Action interface {
	Name(name string) Action
}

type GroupFunc func(router Router)

type Route interface {
	Router
	// Fallback registers a handler to be executed when no other route was matched.
	Fallback(handler contractshttp.HandlerFunc)
	// GetRoutes retrieves all the routes registered with the router.
	GetRoutes() []contractshttp.Info
	// GlobalMiddleware registers global middleware to be applied to all routes of the router.
	GlobalMiddleware(middlewares ...contractshttp.Middleware)
	// Listen starts the HTTP server and listens on the specified listener.
	Listen(l net.Listener) error
	// ListenTLS starts the HTTPS server and listens on the specified listener.
	ListenTLS(l net.Listener) error
	// ListenTLSWithCert starts the HTTPS server with the provided TLS configuration and listens on the specified listener.
	ListenTLSWithCert(l net.Listener, certFile, keyFile string) error
	// Name registers a name for the route.
	Info(name string) contractshttp.Info
	// Recover allows you to set a custom recovery when a request panics
	Recover(recoverFunc func(ctx contractshttp.Context, err any))
	// Run starts the HTTP server and listens on the specified host.
	Run(host ...string) error
	// RunTLS starts the HTTPS server with the provided TLS configuration and listens on the specified host.
	RunTLS(host ...string) error
	// RunTLSWithCert starts the HTTPS server with the provided certificate and key files and listens on the specified host and port.
	RunTLSWithCert(host, certFile, keyFile string) error
	// ServeHTTP serves HTTP requests.
	ServeHTTP(writer http.ResponseWriter, request *http.Request)
	// Shutdown gracefully stop the serve.
	Shutdown(ctx ...context.Context) error
	// Test method to simulate HTTP requests (Fiber driver only)
	Test(request *http.Request) (*http.Response, error)
}

type Router interface {
	// Group creates a new router group with the specified handler.
	Group(handler GroupFunc)
	// Prefix adds a common prefix to the routes registered with the router.
	Prefix(path string) Router
	// Middleware sets the middleware for the router.
	Middleware(middlewares ...contractshttp.Middleware) Router

	// Any registers a new route responding to all verbs.
	Any(path string, handler contractshttp.HandlerFunc) Action
	// Get registers a new GET route with the router.
	Get(path string, handler contractshttp.HandlerFunc) Action
	// Post registers a new POST route with the router.
	Post(path string, handler contractshttp.HandlerFunc) Action
	// Delete registers a new DELETE route with the router.
	Delete(path string, handler contractshttp.HandlerFunc) Action
	// Patch registers a new PATCH route with the router.
	Patch(path string, handler contractshttp.HandlerFunc) Action
	// Put registers a new PUT route with the router.
	Put(path string, handler contractshttp.HandlerFunc) Action
	// Options registers a new OPTIONS route with the router.
	Options(path string, handler contractshttp.HandlerFunc) Action
	// Resource registers RESTful routes for a resource controller.
	Resource(path string, controller contractshttp.ResourceController) Action

	// Static registers a new route with path prefix to serve static files from the provided root directory.
	Static(path, root string) Action
	// StaticFile registers a new route with a specific path to serve a static file from the filesystem.
	StaticFile(path, filepath string) Action
	// StaticFS registers a new route with a path prefix to serve static files from the provided file system.
	StaticFS(path string, fs http.FileSystem) Action
}