mirror of
https://github.com/gofiber/fiber.git
synced 2025-02-25 10:24:05 +00:00
534 lines
16 KiB
Markdown
534 lines
16 KiB
Markdown
<p align="center">
|
|
<a href="https://fiber.wiki">
|
|
<img alt="Fiber" height="125" src="https://github.com/gofiber/docs/blob/master/static/fiber_v2_logo.svg">
|
|
</a>
|
|
<br>
|
|
<a href="https://github.com/gofiber/fiber/blob/master/.github/README.md">
|
|
<img height="20px" src="https://github.com/gofiber/docs/blob/master/static/flags/en.svg">
|
|
</a>
|
|
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_ru.md">
|
|
<img height="20px" src="https://github.com/gofiber/docs/blob/master/static/flags/ru.svg">
|
|
</a>
|
|
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_es.md">
|
|
<img height="20px" src="https://github.com/gofiber/docs/blob/master/static/flags/es.svg">
|
|
</a>
|
|
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_ja.md">
|
|
<img height="20px" src="https://github.com/gofiber/docs/blob/master/static/flags/jp.svg">
|
|
</a>
|
|
<!--<a href="https://github.com/gofiber/fiber/blob/master/.github/README_pt.md">
|
|
<img height="20px" src="https://github.com/gofiber/docs/blob/master/static/flags/pt.svg">
|
|
</a>-->
|
|
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_zh-CN.md">
|
|
<img height="20px" src="https://github.com/gofiber/docs/blob/master/static/flags/ch.svg">
|
|
</a>
|
|
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_de.md">
|
|
<img height="20px" src="https://github.com/gofiber/docs/blob/master/static/flags/de.svg">
|
|
</a>
|
|
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_ko.md">
|
|
<img height="20px" src="https://github.com/gofiber/docs/blob/master/static/flags/ko.svg">
|
|
</a>
|
|
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_fr.md">
|
|
<img height="20px" src="https://github.com/gofiber/docs/blob/master/static/flags/fr.svg">
|
|
</a>
|
|
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_tr.md">
|
|
<img height="20px" src="https://github.com/gofiber/docs/blob/master/static/flags/tr.svg">
|
|
</a>
|
|
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_id.md">
|
|
<img height="20px" src="https://github.com/gofiber/docs/blob/master/static/flags/id.svg">
|
|
</a>
|
|
<br><br>
|
|
<a href="https://github.com/gofiber/fiber/releases">
|
|
<img src="https://img.shields.io/github/release/gofiber/fiber?style=flat-square">
|
|
</a>
|
|
<a href="https://fiber.wiki">
|
|
<img src="https://img.shields.io/badge/api-documentation-blue?style=flat-square">
|
|
</a>
|
|
<a href="https://pkg.go.dev/github.com/gofiber/fiber?tab=doc">
|
|
<img src="https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square">
|
|
</a>
|
|
<a href="#">
|
|
<img src="https://img.shields.io/badge/goreport-A%2B-brightgreen?style=flat-square">
|
|
</a>
|
|
<a href="https://gocover.io/github.com/gofiber/fiber">
|
|
<img src="https://img.shields.io/badge/coverage-91%25-brightgreen?style=flat-square">
|
|
</a>
|
|
<a href="https://travis-ci.org/gofiber/fiber">
|
|
<img src="https://img.shields.io/travis/gofiber/fiber/master.svg?label=linux&style=flat-square">
|
|
</a>
|
|
<a href="https://travis-ci.org/gofiber/fiber">
|
|
<img src="https://img.shields.io/travis/gofiber/fiber/master.svg?label=windows&style=flat-square">
|
|
</a>
|
|
<a href="https://travis-ci.org/gofiber/fiber">
|
|
<img src="https://img.shields.io/travis/gofiber/fiber/master.svg?label=osx&style=flat-square">
|
|
</a>
|
|
</p>
|
|
<p align="center">
|
|
<b>Fiber</b> é um <b>framework web</b> inspirado no <a href="https://github.com/expressjs/express">Express</a>, construído sobre o <a href="https://github.com/valyala/fasthttp">Fasthttp</a>, o motor HTTP <b>mais rápido</b> do <a href="https://golang.org/doc/">Go</a>. Projetado para <b>facilitar</b> e <b>acelerar</b> o desenvolvimento, com <b>zero de alocação de memória</b> e <b>desempenho</b> em mente.
|
|
</p>
|
|
|
|
## ⚡️ Início rápido
|
|
|
|
```go
|
|
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)
|
|
}
|
|
```
|
|
|
|
## ⚙️ Instalação
|
|
|
|
Primeiro de tudo, faça o [download](https://golang.org/dl/) e instale o Go. É necessário a versão `1.11` ou superior.
|
|
|
|
A instalação é feita usando o comando [`go get`](https://golang.org/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them) :
|
|
|
|
```bash
|
|
go get -u github.com/gofiber/fiber/...
|
|
```
|
|
|
|
## 🤖 Benchmarks
|
|
|
|
Esses testes são realizados pelo [TechEmpower](https://github.com/TechEmpower/FrameworkBenchmarks) e [Go Web](https://github.com/smallnest/go-web-framework-benchmark). Se você quiser ver todos os resultados, visite nosso [Wiki](https://fiber.wiki/benchmarks) .
|
|
|
|
<p float="left" align="middle">
|
|
<img src="https://github.com/gofiber/docs/blob/master/.gitbook/assets//benchmark-pipeline.png" width="49%">
|
|
<img src="https://github.com/gofiber/docs/blob/master/.gitbook/assets//benchmark_alloc.png" width="49%">
|
|
</p>
|
|
|
|
## 🎯 Recursos
|
|
|
|
- [Roteamento](https://fiber.wiki/routing) robusto
|
|
- Servir [arquivos estáticos](https://fiber.wiki/application#static)
|
|
- [Desempenho](https://fiber.wiki/benchmarks) extremo
|
|
- [Baixo consumo de memória](https://fiber.wiki/benchmarks)
|
|
- [API de rotas](https://fiber.wiki/context)
|
|
- Suporte para Middleware e [Next](https://fiber.wiki/context#next)
|
|
- Programação [rápida](https://dev.to/koddr/welcome-to-fiber-an-express-js-styled-fastest-web-framework-written-with-on-golang-497) de aplicações de servidor
|
|
- [Template engines](https://fiber.wiki/middleware#template)
|
|
- [WebSocket support](https://fiber.wiki/middleware#websocket)
|
|
- [Rate Limiter](https://fiber.wiki/middleware#limiter)
|
|
- Available in [10 languages](https://fiber.wiki/)
|
|
- E muito mais, [explore o Fiber](https://fiber.wiki/)
|
|
|
|
## 💡 Filosofia
|
|
|
|
Os novos gophers que mudaram do [Node.js](https://nodejs.org/en/about/) para o [Go](https://golang.org/doc/) estão tendo que lidar com uma curva de aprendizado antes que possam começar a criar seus aplicativos web ou microsserviços. O Fiber, como um **framework web**, foi criado com a ideia de ser **minimalista** e seguindo o **caminho UNIX**, para que novos gophers possam, rapidamente, entrar no mundo do Go com uma recepção calorosa e confiável.
|
|
|
|
O Fiber é **inspirado** no Express, o framework web mais popular da Internet. Combinamos a **facilidade** do Express e o **desempenho bruto** do Go. Se você já implementou um aplicativo web com Node.js ( _usando Express.js ou similar_ ), então muitos métodos e princípios parecerão **muito comuns** para você.
|
|
|
|
## 👀 Exemplos
|
|
|
|
Listados abaixo estão alguns exemplos comuns. Se você quiser ver mais exemplos de código, visite nosso [repositório de receitas](https://github.com/gofiber/recipes) ou a [documentação da API](https://fiber.wiki).
|
|
|
|
### Routing
|
|
|
|
📖 https://fiber.wiki/#basic-routing
|
|
|
|
|
|
```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)
|
|
}
|
|
```
|
|
|
|
### Serve static files
|
|
|
|
📖 https://fiber.wiki/application#static
|
|
|
|
```go
|
|
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/any/path/shows/index/html
|
|
|
|
app.Listen(3000)
|
|
}
|
|
```
|
|
|
|
### Middleware & Next
|
|
|
|
📖 https://fiber.wiki/routing#middleware
|
|
📖 https://fiber.wiki/context#next
|
|
|
|
```go
|
|
func main() {
|
|
app := fiber.New()
|
|
|
|
// Match any route
|
|
app.Use(func(c *fiber.Ctx) {
|
|
fmt.Println("First middleware")
|
|
c.Next()
|
|
})
|
|
|
|
// Match all routes starting with /api
|
|
app.Use("/api", func(c *fiber.Ctx) {
|
|
fmt.Println("Second middleware")
|
|
c.Next()
|
|
})
|
|
|
|
// GET /api/register
|
|
app.Get("/api/list", func(c *fiber.Ctx) {
|
|
fmt.Println("Last middleware")
|
|
c.Send("Hello, World!")
|
|
})
|
|
|
|
app.Listen(3000)
|
|
}
|
|
```
|
|
|
|
<details>
|
|
<summary>📚 Show more code examples</summary>
|
|
|
|
### Template engines
|
|
|
|
📖 https://fiber.wiki/application#settings
|
|
📖 https://fiber.wiki/context#render
|
|
📖 https://fiber.wiki/middleware#template
|
|
|
|
Fiber supports the default [Go template engine](https://golang.org/pkg/html/template/)
|
|
|
|
But if you want to use another template engine like [amber](https://github.com/eknkc/amber), [handlebars](https://github.com/aymerick/raymond), [mustache](https://github.com/cbroglie/mustache) or [pug](https://github.com/Joker/jade).
|
|
|
|
You can use our [Template Middleware](https://fiber.wiki/middleware#template).
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"github.com/gofiber/fiber"
|
|
"github.com/gofiber/template"
|
|
)
|
|
|
|
func main() {
|
|
// You can setup template engine before initiation app:
|
|
app := fiber.New(&fiber.Settings{
|
|
TemplateEngine: template.Mustache(),
|
|
TemplateFolder: "./views",
|
|
TemplateExtension: ".tmpl",
|
|
})
|
|
|
|
// OR after initiation app at any convenient location:
|
|
app.Settings.TemplateEngine = template.Mustache()
|
|
app.Settings.TemplateFolder = "./views"
|
|
app.Settings.TemplateExtension = ".tmpl"
|
|
|
|
// And now, you can call template `./views/home.tmpl` like this:
|
|
app.Get("/", func(c *fiber.Ctx) {
|
|
c.Render("home", fiber.Map{
|
|
"title": "Homepage",
|
|
"year": 1999,
|
|
})
|
|
})
|
|
|
|
// ...
|
|
}
|
|
```
|
|
|
|
### Grouping routes into chains
|
|
|
|
📖 https://fiber.wiki/application#group
|
|
|
|
```go
|
|
func main() {
|
|
app := fiber.New()
|
|
|
|
// Root API route
|
|
api := app.Group("/api", cors()) // /api
|
|
|
|
// API v1 routes
|
|
v1 := api.Group("/v1", mysql()) // /api/v1
|
|
v1.Get("/list", handler) // /api/v1/list
|
|
v1.Get("/user", handler) // /api/v1/user
|
|
|
|
// API v2 routes
|
|
v2 := api.Group("/v2", mongodb()) // /api/v2
|
|
v2.Get("/list", handler) // /api/v2/list
|
|
v2.Get("/user", handler) // /api/v2/user
|
|
|
|
// ...
|
|
}
|
|
```
|
|
|
|
### Middleware logger
|
|
|
|
📖 https://fiber.wiki/middleware#logger
|
|
|
|
```go
|
|
import (
|
|
"github.com/gofiber/fiber"
|
|
"github.com/gofiber/logger"
|
|
)
|
|
|
|
func main() {
|
|
app := fiber.New()
|
|
|
|
// Optional logger config
|
|
config := logger.Config{
|
|
Format: "${time} - ${method} ${path}\n",
|
|
TimeFormat: "Mon, 2 Jan 2006 15:04:05 MST",
|
|
}
|
|
|
|
// Logger with config
|
|
app.Use(logger.New(config))
|
|
|
|
app.Listen(3000)
|
|
}
|
|
```
|
|
|
|
### Cross-Origin Resource Sharing (CORS)
|
|
|
|
📖 https://fiber.wiki/middleware#cors
|
|
|
|
```go
|
|
import (
|
|
"github.com/gofiber/fiber"
|
|
"github.com/gofiber/cors"
|
|
)
|
|
|
|
func main() {
|
|
app := fiber.New()
|
|
|
|
// CORS with default config
|
|
app.Use(cors.New())
|
|
|
|
app.Listen(3000)
|
|
}
|
|
```
|
|
|
|
Check CORS by passing any domain in `Origin` header:
|
|
|
|
```bash
|
|
curl -H "Origin: http://example.com" --verbose http://localhost:3000
|
|
```
|
|
|
|
### Custom 404 response
|
|
|
|
📖 https://fiber.wiki/application#http-methods
|
|
|
|
```go
|
|
func main() {
|
|
app := fiber.New()
|
|
|
|
app.Static("/public")
|
|
|
|
app.Get("/demo", func(c *fiber.Ctx) {
|
|
c.Send("This is a demo!")
|
|
})
|
|
|
|
app.Post("/register", func(c *fiber.Ctx) {
|
|
c.Send("Welcome!")
|
|
})
|
|
|
|
// Last middleware to match anything
|
|
app.Use(func(c *fiber.Ctx) {
|
|
c.SendStatus(404)
|
|
// => 404 "Not Found"
|
|
})
|
|
|
|
app.Listen(3000)
|
|
}
|
|
```
|
|
|
|
### JSON Response
|
|
|
|
📖 https://fiber.wiki/context#json
|
|
|
|
```go
|
|
type User struct {
|
|
Name string `json:"name"`
|
|
Age int `json:"age"`
|
|
}
|
|
|
|
func main() {
|
|
app := fiber.New()
|
|
|
|
app.Get("/user", func(c *fiber.Ctx) {
|
|
c.JSON(&User{"John", 20})
|
|
// => {"name":"John", "age":20}
|
|
})
|
|
|
|
app.Get("/json", func(c *fiber.Ctx) {
|
|
c.JSON(fiber.Map{
|
|
"success": true,
|
|
"message": "Hi John!",
|
|
})
|
|
// => {"success":true, "message":"Hi John!"}
|
|
})
|
|
|
|
app.Listen(3000)
|
|
}
|
|
```
|
|
|
|
### WebSocket Upgrade
|
|
|
|
📖 https://fiber.wiki/middleware#websocket
|
|
|
|
```go
|
|
import (
|
|
"github.com/gofiber/fiber"
|
|
"github.com/gofiber/websocket"
|
|
)
|
|
|
|
func main() {
|
|
app := fiber.New()
|
|
|
|
app.Get("/ws", websocket.New(func(c *websocket.Conn) {
|
|
for {
|
|
mt, msg, err := c.ReadMessage()
|
|
if err != nil {
|
|
log.Println("read:", err)
|
|
break
|
|
}
|
|
log.Printf("recv: %s", msg)
|
|
err = c.WriteMessage(mt, msg)
|
|
if err != nil {
|
|
log.Println("write:", err)
|
|
break
|
|
}
|
|
}
|
|
}))
|
|
|
|
app.Listen(3000)
|
|
// ws://localhost:3000/ws
|
|
}
|
|
```
|
|
|
|
### Recover middleware
|
|
|
|
📖 https://fiber.wiki/middleware#recover
|
|
|
|
```go
|
|
import (
|
|
"github.com/gofiber/fiber"
|
|
"github.com/gofiber/recover"
|
|
)
|
|
|
|
func main() {
|
|
app := fiber.New()
|
|
|
|
// Optional recover config
|
|
config := recover.Config{
|
|
Handler: func(c *fiber.Ctx, err error) {
|
|
c.SendString(err.Error())
|
|
c.SendStatus(500)
|
|
},
|
|
}
|
|
|
|
// Logger with custom config
|
|
app.Use(recover.New(config))
|
|
|
|
app.Listen(3000)
|
|
}
|
|
```
|
|
</details>
|
|
|
|
## 💬 Mídia
|
|
|
|
- [Bem-vindo ao Fiber — uma estrutura da Web com estilo Express.js, escrita em Go com ❤️](https://dev.to/koddr/welcome-to-fiber-an-express-js-styled-fastest-web-framework-written-with-on-golang-497) _por [Vic Shóstak](https://github.com/koddr), 03 fev 2020_
|
|
|
|
## 👍 Contribuindo
|
|
|
|
Se você quer **agradecer** e/ou apoiar o desenvolvimento ativo do `Fiber`:
|
|
|
|
1. Deixe uma [estrela no GitHub](https://github.com/gofiber/fiber/stargazers) do projeto.
|
|
2. Tweet sobre o projeto [no seu 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. Escreva um review ou tutorial no [Medium](https://medium.com/), [Dev.to](https://dev.to/) ou blog pessoal.
|
|
4. Nos ajude a traduzir esses `README` e a [documentação da API](https://fiber.wiki/) para outros idiomas.
|
|
|
|
## ☕ Coffee Supporters
|
|
|
|
<table>
|
|
<tr>
|
|
<td align="center">
|
|
<a href="https://github.com/melkorm">
|
|
<img src="https://avatars2.githubusercontent.com/u/619996?s=460&v=4" width="100px"></br>
|
|
<sub><b>melkorm</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/ekaputra07">
|
|
<img src="https://avatars3.githubusercontent.com/u/1094221?s=460&v=4" width="100px"></br>
|
|
<sub><b>ekaputra07</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/bihe">
|
|
<img src="https://avatars1.githubusercontent.com/u/635852?s=460&v=4" width="100px"></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="100px"></br>
|
|
<sub><b>Vic Shóstak</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="100px"></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="100px"></br>
|
|
<sub><b>ToishY</b></sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/gofiber/fiber">
|
|
<img src="https://i.stack.imgur.com/frlIf.png" width="100px"></br>
|
|
<sub><b>JustDave</b></sub>
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<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>
|
|
|
|
## 💻 Code Contributors
|
|
|
|
<img src="https://opencollective.com/fiber/contributors.svg?width=890&button=false" alt="Code Contributors" style="max-width:100%;">
|
|
|
|
## ⚠️ License
|
|
|
|
`Fiber` is free and open-source software licensed under the [MIT License](https://github.com/gofiber/fiber/blob/master/LICENSE) Copyright (c) 2019-present [Fenny](https://github.com/fenny) and [Fiber Contributors](https://github.com/gofiber/fiber/graphs/contributors). Official logo was created by [Vic Shóstak](https://github.com/koddr) and distributed under [Creative Commons](https://creativecommons.org/licenses/by-sa/4.0/) license (CC BY-SA 4.0 International). |