fiber/.github/README_pt.md

Fiber é um framework web inspirado no Express, construído sobre o Fasthttp, o motor HTTP mais rápido do Go. Projetado para facilitar e acelerar o desenvolvimento, com zero de alocação de memória e desempenho em mente.

⚡️ Início rápido

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)
}

🤖 Benchmarks

Esses testes são realizados pelo TechEmpower e Go Web. Se você quiser ver todos os resultados, visite nosso Wiki .

⚙️ Instalação

Primeiro de tudo, faça o download e instale o Go. É necessário a versão 1.11 ou superior.

A instalação é feita usando o comando go get :

go get -u github.com/gofiber/fiber/...

🎯 Recursos

• Roteamento robusto
• Servir arquivos estáticos
• Desempenho extremo
• Baixo consumo de memória
• API de rotas
• Suporte à Middleware e Next
• Programação rápida de aplicações de servidor
• Templates
• Suporte à WebSockets
• Limitador de requisições
• Disponível em 15 línguas
• E muito mais, explore o Fiber

💡 Filosofia

Os novos gophers que mudaram do Node.js para o Go 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 a filosofia 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 com 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 familiares 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 ou a documentação da API.

📖 Roteamento básico

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

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

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

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

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

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

  app.Listen(3000)
}

📖 Servindo arquivos estáticos

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

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

  // Match any route
  app.Use(func(c *fiber.Ctx) {
    fmt.Println("🥇 First handler")
    c.Next()
  })

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

  // GET /api/register
  app.Get("/api/list", func(c *fiber.Ctx) {
    fmt.Println("🥉 Last handler")
    c.Send("Hello, World 👋!")
  })

  app.Listen(3000)
}

📚 Mostrar mais exemplos

Engines de visualização

📖 Settings 📖 Engines 📖 Render

O Fiber usa por padrão o html/template quando nenhuma engine é selecionada.

Se você quiser uma execução parcial ou usar uma engine diferente como amber, handlebars, mustache ou pug etc.. Dê uma olhada no package Template que suporta multiplas engines de visualização.

import (
  "github.com/gofiber/fiber"
  "github.com/gofiber/template/pug"
)

func main() {
  // You can setup Views engine before initiation app:
  app := fiber.New(&fiber.Settings{
    Views: pug.New("./views", ".pug"),
  })

  // OR after initiation app at any convenient location:
  app.Settings.Views = pug.New("./views", ".pug"),

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

  // ...
}

Agrupamento de rotas

📖 Group

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

📖 Logger

import (
  "github.com/gofiber/fiber"
  "github.com/gofiber/fiber/middleware"
)

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

  // Default
  app.Use(middleware.Logger())

  // Custom logging format
  app.Use(middleware.Logger("${method} - ${path}"))

  // Custom Config
  app.Use(middleware.LoggerWithConfig(middleware.LoggerConfig{
    Next: func(ctx *fiber.Ctx) bool {
      return ctx.Path() != "/private"
    },
    Format: "${method} - ${path}",
    Output: io.Writer,
  }))

  app.Listen(3000)
}

Cross-Origin Resource Sharing (CORS)

📖 CORS

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)
}

Verifique o CORS passando qualquer domínio no header Origin:

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

Resposta 404 customizada

📖 HTTP Methods

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)
}

Resposta JSON

📖 JSON

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

📖 Websocket

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
}

Middleware Recover

📖 Recover

import (
    "github.com/gofiber/fiber"
    "github.com/gofiber/fiber/middleware"
)

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

  app.Use(middleware.Recover())

  app.Get("/", func(c *fiber.Ctx) {
    panic("normally this would crash your app")
  })

  app.Listen(3000)
}

🧬Middlewares Fiber

Os middlewares Fiber listados aqui são mantidos pelo Time Fiber.

Middleware	Description	Built-in middleware
adaptor	Converter for net/http handlers to/from Fiber request handlers, special thanks to @arsmn!	-
basicauth	Basic auth middleware provides an HTTP basic authentication. It calls the next handler for valid credentials and 401 Unauthorized for missing or invalid credentials.	-
compress	Compression middleware for Fiber, it supports deflate, gzip and brotli by default.	middleware.Compress()
cors	Enable cross-origin resource sharing CORS with various options.	-
csrf	Protect from CSRF exploits.	-
filesystem	FileSystem middleware for Fiber, special thanks and credits to Alireza Salary	-
favicon	Ignore favicon from logs or serve from memory if a file path is provided.	middleware.Favicon()
helmet	Helps secure your apps by setting various HTTP headers.	-
jwt	JWT returns a JSON Web Token JWT auth middleware.	-
keyauth	Key auth middleware provides a key based authentication.	-
limiter	Rate-limiting middleware for Fiber. Use to limit repeated requests to public APIs and/or endpoints such as password reset.	-
logger	HTTP request/response logger.	middleware.Logger()
pprof	Special thanks to Matthew Lee @mthli	-
recover	Recover middleware recovers from panics anywhere in the stack chain and handles the control to the centralized ErrorHandler.	middleware.Recover()
rewrite	Rewrite middleware rewrites the URL path based on provided rules. It can be helpful for backward compatibility or just creating cleaner and more descriptive links.	-
requestid	Request ID middleware generates a unique id for a request.	middleware.RequestID()
session	This session middleware is build on top of fasthttp/session by @savsgio MIT. Special thanks to @thomasvvugt for helping with this middleware.	-
template	This package contains 8 template engines that can be used with Fiber v1.10.x Go version 1.13 or higher is required.	-
websocket	Based on Fasthttp WebSocket for Fiber with Locals support!	-

🌱 Middlewares Third Party

Esta é uma lista de middlewares criados pela comunidade do Fiber, se quiser ter o seu middleware aqui, é só abrir um PR!

• arsmn/fiber-swagger
• arsmn/fiber-casbin
• arsmn/fiber-introspect
• shareed2k/fiber_tracing
• shareed2k/fiber_limiter
• thomasvvugt/fiber-boilerplate
• arsmn/gqlgen
• kiyonlin/fiber_limiter
• juandiii/go-jwk-security

💬 Mídia

• Welcome to Fiber — an Express.js styled web framework written in Go with ❤️ — 03 Feb 2020
• Fiber released v1.7! 🎉 What's new and is it still fast, flexible and friendly? — 21 Feb 2020
• 🚀 Fiber v1.8. What's new, updated and re-thinked? — 03 Mar 2020
• Is switching from Express to Fiber worth it? 🤔 — 01 Apr 2020
• Creating Fast APIs In Go Using Fiber — 07 Apr 2020
• Building a Basic REST API in Go using Fiber - 23 Apr 2020
• 📺 Building a REST API using GORM and Fiber - 25 Apr 2020
• 🌎 Create a travel list app with Go, Fiber, Angular, MongoDB and Google Cloud Secret Manager - 25 Apr 2020
• Fiber v1.9.6 🔥 How to improve performance by 817% and stay fast, flexible and friendly? - 12 May 2020
• The road to web-based authentication with Fiber ⚡ - 20 May 2020
• Building an Express-style API in Go with Fiber - 10 June 2020
• 基于golang fiber和angular开发web - 19 June 2020
• 基于延迟计算令牌桶的gofiber频率限制中间件实现 - 20 June 2020
• Construir una API en Golang con Fiber 🇪🇸 - 28 June 2020
• 📺Why Go Fiber Is THE New Framework To Learn - 29 June 2020
• 解析Gofiber路由管理 - 08 July 2020
• 📺 Introduction to Fiber - An Express-inspired web framework - 25 July 2020

👍 Contribuindo

Se você quer agradecer e/ou apoiar o desenvolvimento ativo do Fiber:

1. Deixe uma estrela no GitHub do projeto.
2. Tweet sobre o projeto no seu Twitter.
3. Escreva um review ou tutorial no Medium, Dev.to ou blog pessoal.
4. Nos ajude a traduzir a documentação da API no Crowdin
5. Apoie o projeto pagando uma xícara de café.

☕ Apoiadores

Fiber é um projeto open source que usa de doações para pagar seus custos (domínio, GitBook, Netlify e hospedagem serverless). Se você quiser apoiar o projeto, você pode ☕ pagar um café.

	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
	@ankush	☕ 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

‎‍💻 Contribuidores de código

⭐️ Stargazers

⚠️ Licença

Todos os direitos reservados (c) 2019-presente Fenny e Contribuidores. Fiber é software livre e aberto sob a licença MIT. O logo oficial foi criado por Vic Shóstak e distribuído sob a licença Creative Commons (CC BY-SA 4.0 International).

Licença das bibliotecas de terceiros

• schema
• fasthttp
• fasttemplate
• bytebufferpool