Fiberis anExpressinspiredweb frameworkbuilt on top ofFasthttp,thefastestHTTP engine forGo.Designed toeasethings up forfastdevelopment withzero memory allocationandperformancein mind.

---

⚠️Attention

Fiber v3 is currently in beta and under active development. While it offers exciting new features, please note that it may not be stable for production use. We recommend sticking to the latest stable release (v2.x) for mission-critical applications. If you choose to use v3, be prepared for potential bugs and breaking changes. Always check the official documentation and release notes for updates and proceed with caution. Happy coding! 🚀

---

⚙️ Installation

Fiber requiresGo version1.21or higherto run. If you need to install or upgrade Go, visit theofficial Go download page.To start setting up your project. Create a new directory for your project and navigate into it. Then, initialize your project with Go modules by executing the following command in your terminal:

go mod init github /your/repo

To learn more about Go modules and how they work, you can check out theUsing Go Modulesblog post.

After setting up your project, you can install Fiber with thego getcommand:

go get -u github /gofiber/fiber/v3

This command fetches the Fiber package and adds it to your project's dependencies, allowing you to start building your web applications with Fiber.

⚡️ Quickstart

Getting started with Fiber is easy. Here's a basic example to create a simple web server that responds with "Hello, World 👋!" on the root path. This example demonstrates initializing a new Fiber app, setting up a route, and starting the server.

packagemain

import(
"log"

"github /gofiber/fiber/v3"
)

funcmain() {
// Initialize a new Fiber app
app:=fiber.New()

// Define a route for the GET method on the root path '/'
app.Get("/",func(cfiber.Ctx)error{
// Send a string response to the client
returnc.SendString("Hello, World 👋!")
})

// Start the server on port 3000
log.Fatal(app.Listen(":3000"))
}

This simple server is easy to set up and run. It introduces the core concepts of Fiber: app initialization, route definition, and starting the server. Just run this Go program, and visithttp://localhost:3000in your browser to see the message.

Zero Allocation

Fiber is optimized forhigh-performance,meaning values returned fromfiber.Ctxarenotimmutable by default andwillbe re-used across requests. As a rule of thumb, youmustonly use context values within the handler andmust notkeep any references. Once you return from the handler, any values obtained from the context will be re-used in future requests. Visit ourdocumentationto learn more.

🤖 Benchmarks

These tests are performed byTechEmpowerandGo Web.If you want to see all the results, please visit ourWiki.

🎯 Features

• RobustRouting
• ServeStatic Files
• ExtremePerformance
• Low Memoryfootprint
• API Endpoints
• Middleware&Nextsupport
• Rapidserver-side programming
• Template Engines
• WebSocket Support
• Socket.io Support
• Server-Sent Events
• Rate Limiter
• And much more,explore Fiber

💡 Philosophy

New gophers that make the switch fromNode.jstoGoare dealing with a learning curve before they can start building their web applications or microservices. Fiber, as aweb framework,was created with the idea ofminimalismand follows theUNIX way,so that new gophers can quickly enter the world of Go with a warm and trusted welcome.

Fiber isinspiredby Express, the most popular web framework on the Internet. We combined theeaseof Express andraw performanceof Go. If you have ever implemented a web application in Node.js (using Express or similar), then many methods and principles will seemvery commonto you.

Welistento our users inissues,Discordchanneland all over the Internetto create afast,flexibleandfriendlyGo web framework foranytask,deadlineand developerskill!Just like Express does in the JavaScript world.

⚠️Limitations

• Due to Fiber's usage of unsafe, the library may not always be compatible with the latest Go version. Fiber v3 has been tested with Go versions 1.21 and 1.22.
• Fiber is not compatible with net/http interfaces. This means you will not be able to use projects like gqlgen, go-swagger, or any others which are part of the net/http ecosystem.

👀 Examples

Listed below are some of the common examples. If you want to see more code examples, please visit ourRecipes repositoryor visit our hostedAPI documentation.

📖Basic Routing

funcmain() {
app:=fiber.New()

// GET /api/register
app.Get("/api/*",func(cfiber.Ctx)error{
msg:=fmt.Sprintf("✋ %s",c.Params("*"))
returnc.SendString(msg)// => ✋ register
})

// GET /flights/LAX-SFO
app.Get("/flights/:from-:to",func(cfiber.Ctx)error{
msg:=fmt.Sprintf("💸 From: %s, To: %s",c.Params("from"),c.Params("to"))
returnc.SendString(msg)// => 💸 From: LAX, To: SFO
})

// GET /dictionary.txt
app.Get("/:file.:ext",func(cfiber.Ctx)error{
msg:=fmt.Sprintf("📃 %s.%s",c.Params("file"),c.Params("ext"))
returnc.SendString(msg)// => 📃 dictionary.txt
})

// GET /john/75
app.Get("/:name/:age/:gender?",func(cfiber.Ctx)error{
msg:=fmt.Sprintf("👴 %s is %s years old",c.Params("name"),c.Params("age"))
returnc.SendString(msg)// => 👴 john is 75 years old
})

// GET /john
app.Get("/:name",func(cfiber.Ctx)error{
msg:=fmt.Sprintf("Hello, %s 👋!",c.Params("name"))
returnc.SendString(msg)// => Hello john 👋!
})

log.Fatal(app.Listen(":3000"))
}

📖Route Naming

funcmain() {
app:=fiber.New()

// GET /api/register
app.Get("/api/*",func(cfiber.Ctx)error{
msg:=fmt.Sprintf("✋ %s",c.Params("*"))
returnc.SendString(msg)// => ✋ register
}).Name("api")

data,_:=json.MarshalIndent(app.GetRoute("api"),"","")
fmt.Print(string(data))
// Prints:
// {
// "method": "GET",
// "name": "api",
// "path": "/api/*",
// "params": [
// "*1"
// ]
// }

log.Fatal(app.Listen(":3000"))
}

📖Serving Static Files

funcmain() {
app:=fiber.New()

app.Get("/*",static.New("./public"))
// => http://localhost:3000/js/script.js
// => http://localhost:3000/css/style.css

app.Get("/prefix*",static.New("./public"))
// => http://localhost:3000/prefix/js/script.js
// => http://localhost:3000/prefix/css/style.css

app.Get("*",static.New("./public/index.html"))
// => http://localhost:3000/any/path/shows/index/html

log.Fatal(app.Listen(":3000"))
}

📖Middleware & Next

funcmain() {
app:=fiber.New()

// Match any route
app.Use(func(cfiber.Ctx)error{
fmt.Println("🥇 First handler")
returnc.Next()
})

// Match all routes starting with /api
app.Use("/api",func(cfiber.Ctx)error{
fmt.Println("🥈 Second handler")
returnc.Next()
})

// GET /api/list
app.Get("/api/list",func(cfiber.Ctx)error{
fmt.Println("🥉 Last handler")
returnc.SendString("Hello, World 👋!")
})

log.Fatal(app.Listen(":3000"))
}

📚 Show more code examples

Views engines

📖Config 📖Engines 📖Render

Fiber defaults to thehtml/templatewhen no view engine is set.

If you want to execute partials or use a different engine likeamber,handlebars,mustacheorpugetc..

Checkout ourTemplatepackage that support multiple view engines.

packagemain

import(
"log"

"github /gofiber/fiber/v3"
"github /gofiber/template/pug"
)

funcmain() {
// You can setup Views engine before initiation app:
app:=fiber.New(fiber.Config{
Views:pug.New("./views",".pug"),
})

// And now, you can call template `./views/home.pug` like this:
app.Get("/",func(cfiber.Ctx)error{
returnc.Render("home",fiber.Map{
"title":"Homepage",
"year":1999,
})
})

log.Fatal(app.Listen(":3000"))
}

Grouping routes into chains

📖Group

funcmiddleware(cfiber.Ctx)error{
fmt.Println("Don't mind me!")
returnc.Next()
}

funchandler(cfiber.Ctx)error{
returnc.SendString(c.Path())
}

funcmain() {
app:=fiber.New()

// Root API route
api:=app.Group("/api",middleware)// /api

// API v1 routes
v1:=api.Group("/v1",middleware)// /api/v1
v1.Get("/list",handler)// /api/v1/list
v1.Get("/user",handler)// /api/v1/user

// API v2 routes
v2:=api.Group("/v2",middleware)// /api/v2
v2.Get("/list",handler)// /api/v2/list
v2.Get("/user",handler)// /api/v2/user

//...
}

Middleware logger

📖Logger

packagemain

import(
"log"

"github /gofiber/fiber/v3"
"github /gofiber/fiber/v3/middleware/logger"
)

funcmain() {
app:=fiber.New()

app.Use(logger.New())

//...

log.Fatal(app.Listen(":3000"))
}

Cross-Origin Resource Sharing (CORS)

📖CORS

import(
"log"

"github /gofiber/fiber/v3"
"github /gofiber/fiber/v3/middleware/cors"
)

funcmain() {
app:=fiber.New()

app.Use(cors.New())

//...

log.Fatal(app.Listen(":3000"))
}

Check CORS by passing any domain inOriginheader:

curl -H"Origin: http://example"--verbose http://localhost:3000

Custom 404 response

📖HTTP Methods

funcmain() {
app:=fiber.New()

app.Get("/",static.New("./public"))

app.Get("/demo",func(cfiber.Ctx)error{
returnc.SendString("This is a demo!")
})

app.Post("/register",func(cfiber.Ctx)error{
returnc.SendString("Welcome!")
})

// Last middleware to match anything
app.Use(func(cfiber.Ctx)error{
returnc.SendStatus(404)
// => 404 "Not Found"
})

log.Fatal(app.Listen(":3000"))
}

JSON Response

📖JSON

typeUserstruct{
Namestring`json: "name" `
Ageint`json: "age" `
}

funcmain() {
app:=fiber.New()

app.Get("/user",func(cfiber.Ctx)error{
returnc.JSON(&User{"John",20})
// => { "name": "John", "age":20}
})

app.Get("/json",func(cfiber.Ctx)error{
returnc.JSON(fiber.Map{
"success":true,
"message":"Hi John!",
})
// => { "success":true, "message": "Hi John!" }
})

log.Fatal(app.Listen(":3000"))
}

WebSocket Upgrade

📖Websocket

import(
"log"

"github /gofiber/fiber/v3"
"github /gofiber/fiber/v3/middleware/websocket"
)

funcmain() {
app:=fiber.New()

app.Get("/ws",websocket.New(func(c*websocket.Conn) {
for{
mt,msg,err:=c.ReadMessage()
iferr!=nil{
log.Println("read:",err)
break
}
log.Printf("recv: %s",msg)
err=c.WriteMessage(mt,msg)
iferr!=nil{
log.Println("write:",err)
break
}
}
}))

log.Fatal(app.Listen(":3000"))
// ws://localhost:3000/ws
}

Server-Sent Events

📖More Info

import(
"log"

"github /gofiber/fiber/v3"
"github /valyala/fasthttp"
)

funcmain() {
app:=fiber.New()

app.Get("/sse",func(cfiber.Ctx)error{
c.Set("Content-Type","text/event-stream")
c.Set("Cache-Control","no-cache")
c.Set("Connection","keep-alive")
c.Set("Transfer-Encoding","chunked")

c.Context().SetBodyStreamWriter(fasthttp.StreamWriter(func(w*bufio.Writer) {
fmt.Println("WRITER")
variint

for{
i++
msg:=fmt.Sprintf("%d - the time is %v",i,time.Now())
fmt.Fprintf(w,"data: Message: %s\n\n",msg)
fmt.Println(msg)

w.Flush()
time.Sleep(5*time.Second)
}
}))

returnnil
})

log.Fatal(app.Listen(":3000"))
}

Recover Middleware

📖Recover

import(
"log"

"github /gofiber/fiber/v3"
"github /gofiber/fiber/v3/middleware/recover"
)

funcmain() {
app:=fiber.New()

app.Use(recover.New())

app.Get("/",func(cfiber.Ctx)error{
panic("normally this would crash your app")
})

log.Fatal(app.Listen(":3000"))
}

Using Trusted Proxy

📖Config

import(
"log"

"github /gofiber/fiber/v3"
)

funcmain() {
app:=fiber.New(fiber.Config{
EnableTrustedProxyCheck:true,
TrustedProxies:[]string{"0.0.0.0","1.1.1.1/30"},// IP address or IP address range
ProxyHeader:fiber.HeaderXForwardedFor,
})

log.Fatal(app.Listen(":3000"))
}

🧬 Internal Middleware

Here is a list of middleware that are included within the Fiber framework.

Middleware	Description
adaptor	Converter for net/http handlers to/from Fiber request handlers.
basicauth	Provides HTTP basic authentication. It calls the next handler for valid credentials and 401 Unauthorized for missing or invalid credentials.
cache	Intercept and cache HTTP responses.
compress	Compression middleware for Fiber, with support fordeflate,gzip,brotliandzstd.
cors	Enable cross-origin resource sharing (CORS) with various options.
csrf	Protect from CSRF exploits.
earlydata	Adds support for TLS 1.3's early data ( "0-RTT" ) feature.
encryptcookie	Encrypt middleware which encrypts cookie values.
envvar	Expose environment variables with providing an optional config.
etag	Allows for caches to be more efficient and save bandwidth, as a web server does not need to resend a full response if the content has not changed.
expvar	Serves via its HTTP server runtime exposed variants in the JSON format.
favicon	Ignore favicon from logs or serve from memory if a file path is provided.
healthcheck	Liveness and Readiness probes for Fiber.
helmet	Helps secure your apps by setting various HTTP headers.
idempotency	Allows for fault-tolerant APIs where duplicate requests do not erroneously cause the same action performed multiple times on the server-side.
keyauth	Adds support for key based authentication.
limiter	Adds Rate-limiting support to Fiber. Use to limit repeated requests to public APIs and/or endpoints such as password reset.
logger	HTTP request/response logger.
pprof	Serves runtime profiling data in pprof format.
proxy	Allows you to proxy requests to multiple servers.
recover	Recovers from panics anywhere in the stack chain and handles the control to the centralized ErrorHandler.
redirect	Redirect middleware.
requestid	Adds a request ID to every request.
rewrite	Rewrites the URL path based on provided rules. It can be helpful for backward compatibility or just creating cleaner and more descriptive links.
session	Session middleware. NOTE: This middleware uses our Storage package.
skip	Skip middleware that skips a wrapped handler if a predicate is true.
static	Static middleware for Fiber that serves static files such asimages,CSS,andJavaScript.
timeout	Adds a max time for a request and forwards to ErrorHandler if it is exceeded.

🧬 External Middleware

List of externally hosted middleware modules and maintained by theFiber team.

Middleware	Description
contrib	Third party middlewares
storage	Premade storage drivers that implement the Storage interface, designed to be used with various Fiber middlewares.
template	This package contains 9 template engines that can be used with Fiberv3Go version 1.21 or higher is required.

🕶️ Awesome List

For more articles, middlewares, examples or tools check ourawesome list.

👍 Contribute

If you want to sayThank Youand/or support the active development ofFiber:

1. Add aGitHub Starto the project.
2. Tweet about the projecton your 𝕏 (Twitter).
3. Write a review or tutorial onMedium,Dev.toor personal blog.
4. Support the project by donating acup of coffee.

🖥️ Development

To ensure your contributions are ready for a Pull Request, please use the followingMakefilecommands. These tools help maintain code quality, consistency.

• make help:Display available commands.
• make audit:Conduct quality checks.
• make benchmark:Benchmark code performance.
• make coverage:Generate test coverage report.
• make format:Automatically format code.
• make lint:Run lint checks.
• make test:Execute all tests.
• make tidy:Tidy dependencies.

Run these commands to ensure your code adheres to project standards and best practices.

☕ Supporters

Fiber is an open source project that runs on donations to pay the bills e.g. our domain name, gitbook, netlify and serverless hosting. If you want to support Fiber, you can ☕buy a coffee here.

	User	Donation
	@destari	☕ x 10
	@dembygenesis	☕ x 5
	@thomasvvugt	☕ x 5
	@hendratommy	☕ x 5
	@ekaputra07	☕ x 5
	@jorgefuertes	☕ x 5
	@candidosales	☕ x 5
	@l0nax	☕ x 3
	@bihe	☕ x 3
	@justdave	☕ x 3
	@koddr	☕ x 1
	@lapolinar	☕ x 1
	@diegowifi	☕ x 1
	@ssimk0	☕ x 1
	@raymayemir	☕ x 1
	@melkorm	☕ x 1
	@marvinjwendt	☕ x 1
	@toishy	☕ x 1

💻 Code Contributors

⭐️ Stargazers

🧾 License

Copyright (c) 2019-presentFennyandContributors.Fiberis free and open-source software licensed under theMIT License.Official logo was created byVic Shóstakand distributed underCreative Commonslicense (CC BY-SA 4.0 International).