1
0
mirror of https://github.com/gofiber/fiber.git synced 2025-02-23 18:04:05 +00:00
2020-02-14 02:05:39 +01:00
..
2020-02-12 04:47:28 +01:00
2020-02-03 16:33:56 +01:00
2020-02-11 04:47:09 +01:00
2020-02-12 07:04:57 +01:00
2020-02-12 04:40:41 +01:00
2020-02-05 22:17:35 +01:00
2020-02-08 20:35:00 +01:00
2020-02-13 06:48:14 +01:00
2020-02-02 12:45:19 +03:00

Fiber



Fiber is an Express inspired web framework build on top of Fasthttp, the fastest HTTP engine for Go. Designed to ease things up for fast development with zero memory allocation and performance in mind.

Quickstart

package main

import "github.com/gofiber/fiber"

func main() {
  app := fiber.New()

  app.Get("/", func(c *fiber.Ctx) {
    c.Send("Hello, World!")
  })

  app.Listen(3000)
}

⚙️ Installation

First of all, download and install Go. 1.11 or higher is required.

Installation is done using the go get command:

go get github.com/gofiber/fiber

🤖 Benchmarks

These tests are performed by TechEmpower and Go Web. If you want to see all results, please visit our Wiki.

🎯 Features

💡 Philosophy

New gophers that make the switch from Node.js to Go are dealing with a learning curve before they can start building their web applications or microservices. Fiber, as a web framework, was created with the idea of minimalism and follow UNIX way, so that new gophers can quickly enter the world of Go with a warm and trusted welcome.

Fiber is inspired by Express, the most popular web framework on the Internet. We combined the ease of Express and raw performance of Go. If you have ever implemented a web application on Node.js (using Express or similar), then many methods and principles will seem very common to you.

👀 Examples

Listed below are some of the common examples. If you want to see more code examples, please visit our Recipes repository or visit our API documentation.

Static files

func main() {
  app := fiber.New()

  app.Static("./public")
  // => http://localhost:3000/js/script.js
  // => http://localhost:3000/css/style.css

  app.Static("/prefix", "./public")
  // => http://localhost:3000/prefix/js/script.js
  // => http://localhost:3000/prefix/css/style.css

  app.Static("*", "./public/index.html")
  // => http://localhost:3000/anything/returns/the/index/file

  app.Listen(3000)
}

Routing

📜 Show code snippet ```go func main() { app := fiber.New()
// GET /john
app.Get("/:name", func(c *fiber.Ctx) {
  fmt.Printf("Hello %s!", c.Params("name"))
  // => Hello john!
})

// GET /john
app.Get("/:name/:age?", func(c *fiber.Ctx) {
  fmt.Printf("Name: %s, Age: %s", c.Params("name"), c.Params("age"))
  // => Name: john, Age:
})

// GET /api/register
app.Get("/api*", func(c *fiber.Ctx) {
  fmt.Printf("/api%s", c.Params("*"))
  // => /api/register
})

app.Listen(3000)

}

</summary>

### Middleware

<details>
<summary>📜 Show code snippet</summary>
```go
func main() {
  app := fiber.New()

  // Match any post route
  app.Post(func(c *fiber.Ctx) {
    user, pass, ok := c.BasicAuth()
    if !ok || user != "john" || pass != "doe" {
      c.Status(403).Send("Sorry John")
      return
    }
    c.Next()
  })

  // Match all routes starting with /api
  app.Use("/api", func(c *fiber.Ctx) {
    c.Set("Access-Control-Allow-Origin", "*")
    c.Set("Access-Control-Allow-Headers", "X-Requested-With")
    c.Next()
  })

  // Optional param
  app.Post("/api/register", func(c *fiber.Ctx) {
    username := c.Body("username")
    password := c.Body("password")
    // ..
  })

  app.Listen(3000)
}

404 Handling

📜 Show code snippet ```go func main() { app := fiber.New()
// Serve static files from "public" directory
app.Static("./public")

// Last middleware
app.Use(func(c *fiber.Ctx) {
  c.SendStatus(404) // => 404 "Not Found"
})

app.Listen(3000)

}

</summary>

### JSON Response

<details>
<summary>📜 Show code snippet</summary>
```go
func main() {
  app := fiber.New()

  type User struct {
    Name string `json:"name"`
    Age  int    `json:"age"`
  }

  // Serialize JSON
  app.Get("/json", func(c *fiber.Ctx) {
    c.JSON(&User{"John", 20})
  })

  app.Listen(3000)
}

Recover

📜 Show code snippet ```go func main() { app := fiber.New()
app.Get("/json", func(c *fiber.Ctx) {
  panic("Something went wrong!")
})

app.Recover(func(c *fiber.Ctx) {
  c.Status(500).Send(c.Error())
})

app.Listen(3000)

}

</details>

## 💬 Media

- [Welcome to Fiber — an Express.js styled web framework written in Go with ❤️](https://dev.to/koddr/welcome-to-fiber-an-express-js-styled-fastest-web-framework-written-with-on-golang-497) _by [Vic Shóstak](https://github.com/koddr), 03 Feb 2020_

## 👍 Contribute

If you want to say **thank you** and/or support the active development of `Fiber`:

1. Add a [GitHub Star](https://github.com/gofiber/fiber/stargazers) to the project.
2. Tweet about the project [on your Twitter](https://twitter.com/intent/tweet?text=%F0%9F%9A%80%20Fiber%20%E2%80%94%20is%20an%20Express.js%20inspired%20web%20framework%20build%20on%20Fasthttp%20for%20%23Go%20https%3A%2F%2Fgithub.com%2Fgofiber%2Ffiber).
3. Write a review or tutorial on [Medium](https://medium.com/), [Dev.to](https://dev.to/) or personal blog.
4. Help us to translate this `README` to another language.


## ☕ Supporters

<a href="https://www.buymeacoffee.com/fenny" target="_blank"><img src="https://github.com/gofiber/docs/blob/master/static/buy-morning-coffee-3x.gif" alt="Buy Me A Coffee" height="100" ></a>
<table>
<tr>
  <td align="center">
      <a href="https://github.com/bihe">
        <img src="https://avatars1.githubusercontent.com/u/635852?s=460&v=4" width="75"></br>
        <sub><b>HenrikBinggl</b></sub>
      </a>
  </td>
  <td align="center">
    <a href="https://github.com/koddr">
      <img src="https://avatars0.githubusercontent.com/u/11155743?s=460&v=4" width="75"></br>
      <sub><b>koddr</b></sub>
    </a>
  </td>
  <td align="center">
    <a href="https://github.com/MarvinJWendt">
      <img src="https://avatars1.githubusercontent.com/u/31022056?s=460&v=4" width="75"></br>
      <sub><b>MarvinJWendt</b></sub>
    </a>
  </td>
  <td align="center">
    <a href="https://github.com/toishy">
      <img src="https://avatars1.githubusercontent.com/u/31921460?s=460&v=4" width="75"></br>
      <sub><b>ToishY</b></sub>
    </a>
  </td>
</tr>
</table>

## ⭐️ Stars

<a href="https://starchart.cc/gofiber/fiber" rel="nofollow"><img src="https://starchart.cc/gofiber/fiber.svg" alt="Stars over time" style="max-width:100%;"></a>

## ⚠️ License

`Fiber` is free and open-source software licensed under the [MIT License](https://github.com/gofiber/fiber/blob/master/LICENSE).