fiber

package module
v1.4.0 Latest Latest
Warning

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

 Go to latest Published: Jul 20, 2025 License: MIT Imports: 47 Imported by: 1

README

Fiber

Doc Go Release Test Report Card Codecov License

Fiber http driver for Goravel.

Version

goravel/fiber goravel/framework
v1.4.x v1.16.x
v1.3.x v1.15.x
v1.2.x v1.14.x
v1.1.x v1.13.x

Install

Run the command below in your project to install the package automatically:

./artisan package:install github.com/goravel/fiber

Or check the setup file to install the package manually.

Testing

Run command below to run test:

go test ./...

Documentation

Index

Constants

View Source 
const BindingRoute = "goravel.fiber.route"

Variables

View Source 
var (
	App              foundation.Application
	ConfigFacade     config.Config
	LogFacade        log.Log
	ValidationFacade validation.Validation
	ViewFacade       http.View
)

Functions

func Background 

func Background() http.Context

func Cors added in v1.1.6 

func Cors() http.Middleware

func NewAction added in v1.4.0 

func NewAction(method, path, handler string) contractsroute.Action

func NewContextRequest added in v1.1.6 

func NewContextRequest(ctx *Context, log log.Log, validation contractsvalidate.Validation) contractshttp.ContextRequest

func NewContextResponse added in v1.1.6 

func NewContextResponse(instance *fiber.Ctx, origin contractshttp.ResponseOrigin) contractshttp.ContextResponse

func NewGroup added in v1.0.4 

func NewGroup(config config.Config, instance *fiber.App, prefix string, middlewares []contractshttp.Middleware, lastMiddlewares []contractshttp.Middleware) contractsroute.Router

func NewStatus added in v1.1.4 

func NewStatus(instance *fiber.Ctx, code int) contractshttp.ResponseStatus

func ResponseMiddleware added in v1.0.4 

func ResponseMiddleware() contractshttp.Middleware

func Timeout added in v1.3.0 

func Timeout(timeout time.Duration) contractshttp.Middleware

Timeout creates middleware to set a timeout for a request. NOTICE: It does not cancel long running executions. Underlying executions must handle timeout by using context.Context parameter. For details, see https://github.com/valyala/fasthttp/issues/965

Types

type Action added in v1.4.0 

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

func (*Action) Name added in v1.4.0 

func (r *Action) Name(name string) contractsroute.Action

type Context added in v1.0.4 

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

func NewContext added in v1.0.4 

func NewContext(c *fiber.Ctx) *Context

func (*Context) Context added in v1.0.4 

func (c *Context) Context() context.Context

func (*Context) Deadline added in v1.0.4 

func (c *Context) Deadline() (deadline time.Time, ok bool)

func (*Context) Done added in v1.0.4 

func (c *Context) Done() <-chan struct{}

func (*Context) Err added in v1.0.4 

func (c *Context) Err() error

func (*Context) Instance added in v1.0.4 

func (c *Context) Instance() *fiber.Ctx

func (*Context) Request added in v1.0.4 

func (c *Context) Request() http.ContextRequest

func (*Context) Response added in v1.0.4 

func (c *Context) Response() http.ContextResponse

func (*Context) Value added in v1.0.4 

func (c *Context) Value(key any) any

func (*Context) WithContext added in v1.3.0 

func (c *Context) WithContext(ctx context.Context)

func (*Context) WithValue added in v1.0.4 

func (c *Context) WithValue(key any, value any)

type ContextRequest added in v1.1.6 

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

func (*ContextRequest) Abort added in v1.3.0 

func (r *ContextRequest) Abort(code ...int)

func (*ContextRequest) AbortWithStatus added in v1.1.6 

func (r *ContextRequest) AbortWithStatus(code int)

DEPRECATED: Use Abort instead

func (*ContextRequest) AbortWithStatusJson added in v1.1.6 

func (r *ContextRequest) AbortWithStatusJson(code int, jsonObj any)

DEPRECATED: Use Response().Json().Abort() instead

func (*ContextRequest) All added in v1.1.6 

func (r *ContextRequest) All() map[string]any

func (*ContextRequest) Bind added in v1.1.6 

func (r *ContextRequest) Bind(obj any) error

func (*ContextRequest) BindQuery added in v1.3.0 

func (r *ContextRequest) BindQuery(obj any) error

func (*ContextRequest) Cookie added in v1.2.0 

func (r *ContextRequest) Cookie(key string, defaultValue ...string) string

func (*ContextRequest) File added in v1.1.6 

func (r *ContextRequest) File(name string) (contractsfilesystem.File, error)

func (*ContextRequest) Files added in v1.4.0 

func (r *ContextRequest) Files(name string) ([]contractsfilesystem.File, error)

func (*ContextRequest) Form added in v1.1.6 

func (r *ContextRequest) Form(key string, defaultValue ...string) string

func (*ContextRequest) FullUrl added in v1.1.6 

func (r *ContextRequest) FullUrl() string

func (*ContextRequest) HasSession added in v1.2.0 

func (r *ContextRequest) HasSession() bool

func (*ContextRequest) Header added in v1.1.6 

func (r *ContextRequest) Header(key string, defaultValue ...string) string

func (*ContextRequest) Headers added in v1.1.6 

func (r *ContextRequest) Headers() http.Header

func (*ContextRequest) Host added in v1.1.6 

func (r *ContextRequest) Host() string

func (*ContextRequest) Info added in v1.4.0 

func (r *ContextRequest) Info() contractshttp.Info

func (*ContextRequest) Input added in v1.1.6 

func (r *ContextRequest) Input(key string, defaultValue ...string) string

func (*ContextRequest) InputArray added in v1.1.6 

func (r *ContextRequest) InputArray(key string, defaultValue ...[]string) []string

func (*ContextRequest) InputBool added in v1.1.6 

func (r *ContextRequest) InputBool(key string, defaultValue ...bool) bool

func (*ContextRequest) InputInt added in v1.1.6 

func (r *ContextRequest) InputInt(key string, defaultValue ...int) int

func (*ContextRequest) InputInt64 added in v1.1.6 

func (r *ContextRequest) InputInt64(key string, defaultValue ...int64) int64

func (*ContextRequest) InputMap added in v1.1.6 

func (r *ContextRequest) InputMap(key string, defaultValue ...map[string]any) map[string]any

func (*ContextRequest) InputMapArray added in v1.4.0 

func (r *ContextRequest) InputMapArray(key string, defaultValue ...[]map[string]any) []map[string]any

func (*ContextRequest) Ip added in v1.1.6 

func (r *ContextRequest) Ip() string

func (*ContextRequest) Json added in v1.1.6 

func (r *ContextRequest) Json(key string, defaultValue ...string) string

func (*ContextRequest) Method added in v1.1.6 

func (r *ContextRequest) Method() string

func (*ContextRequest) Name added in v1.4.0 

func (r *ContextRequest) Name() string

func (*ContextRequest) Next added in v1.1.6 

func (r *ContextRequest) Next()

func (*ContextRequest) Origin added in v1.1.6 

func (r *ContextRequest) Origin() *http.Request

func (*ContextRequest) OriginPath added in v1.4.0 

func (r *ContextRequest) OriginPath() string

func (*ContextRequest) Path added in v1.1.6 

func (r *ContextRequest) Path() string

func (*ContextRequest) Queries added in v1.1.6 

func (r *ContextRequest) Queries() map[string]string

func (*ContextRequest) Query added in v1.1.6 

func (r *ContextRequest) Query(key string, defaultValue ...string) string

func (*ContextRequest) QueryArray added in v1.1.6 

func (r *ContextRequest) QueryArray(key string) []string

func (*ContextRequest) QueryBool added in v1.1.6 

func (r *ContextRequest) QueryBool(key string, defaultValue ...bool) bool

func (*ContextRequest) QueryInt added in v1.1.6 

func (r *ContextRequest) QueryInt(key string, defaultValue ...int) int

func (*ContextRequest) QueryInt64 added in v1.1.6 

func (r *ContextRequest) QueryInt64(key string, defaultValue ...int64) int64

func (*ContextRequest) QueryMap added in v1.1.6 

func (r *ContextRequest) QueryMap(key string) map[string]string

func (*ContextRequest) Route added in v1.1.6 

func (r *ContextRequest) Route(key string) string

func (*ContextRequest) RouteInt added in v1.1.6 

func (r *ContextRequest) RouteInt(key string) int

func (*ContextRequest) RouteInt64 added in v1.1.6 

func (r *ContextRequest) RouteInt64(key string) int64

func (*ContextRequest) Session added in v1.2.0 

func (r *ContextRequest) Session() contractsession.Session

func (*ContextRequest) SetSession added in v1.2.0 

func (r *ContextRequest) SetSession(session contractsession.Session) contractshttp.ContextRequest

func (*ContextRequest) Url added in v1.1.6 

func (r *ContextRequest) Url() string

func (*ContextRequest) Validate added in v1.1.6 

func (r *ContextRequest) Validate(rules map[string]string, options ...contractsvalidate.Option) (contractsvalidate.Validator, error)

func (*ContextRequest) ValidateRequest added in v1.1.6 

func (r *ContextRequest) ValidateRequest(request contractshttp.FormRequest) (contractsvalidate.Errors, error)

type ContextResponse added in v1.1.6 

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

func (*ContextResponse) Cookie added in v1.2.0 

func (r *ContextResponse) Cookie(cookie contractshttp.Cookie) contractshttp.ContextResponse

func (*ContextResponse) Data added in v1.1.6 

func (r *ContextResponse) Data(code int, contentType string, data []byte) contractshttp.AbortableResponse

func (*ContextResponse) Download added in v1.1.6 

func (r *ContextResponse) Download(filepath, filename string) contractshttp.Response

func (*ContextResponse) File added in v1.1.6 

func (r *ContextResponse) File(filepath string) contractshttp.Response

func (*ContextResponse) Flush added in v1.1.6 

func (r *ContextResponse) Flush()

func (*ContextResponse) Header added in v1.1.6 

func (r *ContextResponse) Header(key, value string) contractshttp.ContextResponse

func (*ContextResponse) Json added in v1.1.6 

func (r *ContextResponse) Json(code int, obj any) contractshttp.AbortableResponse

func (*ContextResponse) NoContent added in v1.2.0 

func (r *ContextResponse) NoContent(code ...int) contractshttp.AbortableResponse

func (*ContextResponse) Origin added in v1.1.6 

func (r *ContextResponse) Origin() contractshttp.ResponseOrigin

func (*ContextResponse) Redirect added in v1.1.6 

func (r *ContextResponse) Redirect(code int, location string) contractshttp.AbortableResponse

func (*ContextResponse) Status added in v1.1.6 

func (r *ContextResponse) Status(code int) contractshttp.ResponseStatus

func (*ContextResponse) Stream added in v1.3.0 

func (r *ContextResponse) Stream(code int, step func(w contractshttp.StreamWriter) error) contractshttp.Response

func (*ContextResponse) String added in v1.1.6 

func (r *ContextResponse) String(code int, format string, values ...any) contractshttp.AbortableResponse

func (*ContextResponse) Success added in v1.1.6 

func (r *ContextResponse) Success() contractshttp.ResponseStatus

func (*ContextResponse) View added in v1.1.6 

func (r *ContextResponse) View() contractshttp.ResponseView

func (*ContextResponse) WithoutCookie added in v1.2.0 

func (r *ContextResponse) WithoutCookie(name string) contractshttp.ContextResponse

func (*ContextResponse) Writer added in v1.1.6 

func (r *ContextResponse) Writer() http.ResponseWriter

type DataResponse added in v1.1.6 

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

func (*DataResponse) Abort added in v1.3.0 

func (r *DataResponse) Abort() error

func (*DataResponse) Render added in v1.1.6 

func (r *DataResponse) Render() error

type DownloadResponse added in v1.1.6 

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

func (*DownloadResponse) Render added in v1.1.6 

func (r *DownloadResponse) Render() error

type FileResponse added in v1.1.6 

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

func (*FileResponse) Render added in v1.1.6 

func (r *FileResponse) Render() error

type Group added in v1.0.4 

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

func (*Group) Any added in v1.0.4 

func (r *Group) Any(path string, handler contractshttp.HandlerFunc) contractsroute.Action

func (*Group) Delete added in v1.0.4 

func (r *Group) Delete(path string, handler contractshttp.HandlerFunc) contractsroute.Action

func (*Group) Get added in v1.0.4 

func (r *Group) Get(path string, handler contractshttp.HandlerFunc) contractsroute.Action

func (*Group) Group added in v1.0.4 

func (r *Group) Group(handler contractsroute.GroupFunc)

func (*Group) Middleware added in v1.0.4 

func (r *Group) Middleware(middlewares ...contractshttp.Middleware) contractsroute.Router

func (*Group) Options added in v1.0.4 

func (r *Group) Options(path string, handler contractshttp.HandlerFunc) contractsroute.Action

func (*Group) Patch added in v1.0.4 

func (r *Group) Patch(path string, handler contractshttp.HandlerFunc) contractsroute.Action

func (*Group) Post added in v1.0.4 

func (r *Group) Post(path string, handler contractshttp.HandlerFunc) contractsroute.Action

func (*Group) Prefix added in v1.0.4 

func (r *Group) Prefix(path string) contractsroute.Router

func (*Group) Put added in v1.0.4 

func (r *Group) Put(path string, handler contractshttp.HandlerFunc) contractsroute.Action

func (*Group) Resource added in v1.0.4 

func (r *Group) Resource(path string, controller contractshttp.ResourceController) contractsroute.Action

func (*Group) Static added in v1.0.4 

func (r *Group) Static(path, root string) contractsroute.Action

func (*Group) StaticFS added in v1.0.4 

func (r *Group) StaticFS(path string, fs http.FileSystem) contractsroute.Action

func (*Group) StaticFile added in v1.0.4 

func (r *Group) StaticFile(path, filePath string) contractsroute.Action

type HtmlResponse added in v1.1.6 

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

func (*HtmlResponse) Render added in v1.1.6 

func (r *HtmlResponse) Render() error

type JsonResponse added in v1.1.6 

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

func (*JsonResponse) Abort added in v1.3.0 

func (r *JsonResponse) Abort() error

func (*JsonResponse) Render added in v1.1.6 

func (r *JsonResponse) Render() error

type NoContentResponse added in v1.2.0 

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

func (*NoContentResponse) Abort added in v1.3.0 

func (r *NoContentResponse) Abort() error

func (*NoContentResponse) Render added in v1.2.0 

func (r *NoContentResponse) Render() error

type RedirectResponse added in v1.1.6 

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

func (*RedirectResponse) Abort added in v1.3.0 

func (r *RedirectResponse) Abort() error

func (*RedirectResponse) Render added in v1.1.6 

func (r *RedirectResponse) Render() error

type ResponseOrigin added in v1.0.4 

type ResponseOrigin struct {
	*fiber.Ctx
}

func (*ResponseOrigin) Body added in v1.0.4 

func (w *ResponseOrigin) Body() *bytes.Buffer

func (*ResponseOrigin) Header added in v1.0.4 

func (w *ResponseOrigin) Header() http.Header

func (*ResponseOrigin) Size added in v1.0.4 

func (w *ResponseOrigin) Size() int

func (*ResponseOrigin) Status added in v1.0.4 

func (w *ResponseOrigin) Status() int

type Route added in v1.0.4 

type Route struct {
	route.Router
	// contains filtered or unexported fields
}

Route fiber route Route fiber 路由

func NewRoute added in v1.0.4 

func NewRoute(config config.Config, parameters map[string]any) (*Route, error)

NewRoute create new fiber route instance NewRoute 创建新的 fiber 路由实例

func (*Route) Fallback added in v1.0.4 

func (r *Route) Fallback(handler contractshttp.HandlerFunc)

Fallback set fallback handler Fallback 设置回退处理程序

func (*Route) GetRoutes added in v1.4.0 

func (r *Route) GetRoutes() []contractshttp.Info

GetRoutes get all routes

func (*Route) GlobalMiddleware added in v1.0.4 

func (r *Route) GlobalMiddleware(middlewares ...contractshttp.Middleware)

GlobalMiddleware set global middleware GlobalMiddleware 设置全局中间件

func (*Route) Info added in v1.4.0 

func (r *Route) Info(name string) contractshttp.Info

func (*Route) Listen added in v1.3.0 

func (r *Route) Listen(l net.Listener) error

Listen listen server Listen 监听服务器

func (*Route) ListenTLS added in v1.3.0 

func (r *Route) ListenTLS(l net.Listener) error

ListenTLS listen TLS server ListenTLS 监听 TLS 服务器

func (*Route) ListenTLSWithCert added in v1.3.0 

func (r *Route) ListenTLSWithCert(l net.Listener, certFile, keyFile string) error

ListenTLSWithCert listen TLS server with cert file and key file ListenTLSWithCert 使用证书文件和密钥文件监听 TLS 服务器

func (*Route) Recover added in v1.3.0 

func (r *Route) Recover(callback func(ctx contractshttp.Context, err any))

func (*Route) Run added in v1.0.4 

func (r *Route) Run(host ...string) error

Run run server Run 运行服务器

func (*Route) RunTLS added in v1.0.4 

func (r *Route) RunTLS(host ...string) error

RunTLS run TLS server RunTLS 运行 TLS 服务器

func (*Route) RunTLSWithCert added in v1.0.4 

func (r *Route) RunTLSWithCert(host, certFile, keyFile string) error

RunTLSWithCert run TLS server with cert file and key file RunTLSWithCert 使用证书文件和密钥文件运行 TLS 服务器

func (*Route) ServeHTTP added in v1.0.4 

func (r *Route) ServeHTTP(writer http.ResponseWriter, request *http.Request)

ServeHTTP serve http request (Not support) ServeHTTP 服务 HTTP 请求 (不支持)

func (*Route) Shutdown added in v1.2.3 

func (r *Route) Shutdown(ctx ...context.Context) error

Shutdown gracefully shuts down the server Shutdown 优雅退出HTTP Server

func (*Route) Test added in v1.0.4 

func (r *Route) Test(request *http.Request) (*http.Response, error)

Test for unit test Test 用于单元测试

type ServiceProvider 

type ServiceProvider struct{}

func (*ServiceProvider) Boot 

func (r *ServiceProvider) Boot(app foundation.Application)

func (*ServiceProvider) Register 

func (r *ServiceProvider) Register(app foundation.Application)

func (*ServiceProvider) Relationship added in v1.4.0 

func (r *ServiceProvider) Relationship() binding.Relationship

type Status added in v1.1.4 

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

func (*Status) Data added in v1.1.4 

func (r *Status) Data(contentType string, data []byte) contractshttp.AbortableResponse

func (*Status) Json added in v1.1.4 

func (r *Status) Json(obj any) contractshttp.AbortableResponse

func (*Status) Stream added in v1.3.0 

func (r *Status) Stream(step func(w contractshttp.StreamWriter) error) contractshttp.Response

func (*Status) String added in v1.1.4 

func (r *Status) String(format string, values ...any) contractshttp.AbortableResponse

type StreamResponse added in v1.3.0 

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

func (*StreamResponse) Render added in v1.3.0 

func (r *StreamResponse) Render() (err error)

type StringResponse added in v1.1.6 

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

func (*StringResponse) Abort added in v1.3.0 

func (r *StringResponse) Abort() error

func (*StringResponse) Render added in v1.1.6 

func (r *StringResponse) Render() error

type View added in v1.1.6 

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

func NewView added in v1.1.6 

func NewView(instance *fiber.Ctx) *View

func (*View) First added in v1.1.6 

func (receive *View) First(views []string, data ...any) contractshttp.Response

func (*View) Make added in v1.1.6 

func (receive *View) Make(view string, data ...any) contractshttp.Response

Source Files

View all Source files

Directories

Path Synopsis

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.