1
0
mirror of https://github.com/gofiber/fiber.git synced 2025-02-25 07:44:22 +00:00
fiber/.github/README_pt.md

484 lines
15 KiB
Markdown
Raw Normal View History

2020-02-12 00:04:56 +01:00
<p align="center">
<a href="https://fiber.wiki">
2020-02-21 16:56:32 +01:00
<img alt="Fiber" height="125" src="https://github.com/gofiber/docs/blob/master/static/fiber_v2_logo.svg">
2020-02-12 00:04:56 +01:00
</a>
2020-02-21 16:56:32 +01:00
<br>
2020-02-14 02:05:39 +01:00
<a href="https://github.com/gofiber/fiber/blob/master/.github/README.md">
2020-02-12 00:04:56 +01:00
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/gb.svg">
</a>
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_ru.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/ru.svg">
</a>
2020-02-13 00:04:10 +03:00
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_es.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/es.svg">
</a>
2020-02-12 00:04:56 +01:00
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_ja.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/jp.svg">
</a>
2020-02-13 00:04:10 +03:00
<!--<a href="https://github.com/gofiber/fiber/blob/master/.github/README_pt.md">
2020-02-12 00:04:56 +01:00
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/pt.svg">
2020-02-13 00:04:10 +03:00
</a>-->
2020-02-12 00:04:56 +01:00
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_zh-CN.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/cn.svg">
</a>
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_de.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/de.svg">
</a>
2020-02-12 01:03:52 +01:00
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_ko.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/kr.svg">
</a>
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_fr.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/fr.svg">
</a>
2020-02-19 15:48:41 +03:00
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_tr.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/tr.svg">
</a>
2020-02-12 00:04:56 +01:00
<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>
2020-02-22 11:09:32 +08:00
<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>
2020-02-12 00:04:56 +01:00
<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>
2020-02-13 00:04:10 +03:00
<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>
2020-02-12 00:04:56 +01:00
</p>
<p align="center">
2020-02-11 21:17:02 -03:00
<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.
2020-02-12 00:04:56 +01:00
</p>
2020-02-11 00:31:49 +00:00
## ⚡️ 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
2020-02-11 21:17:02 -03:00
Primeiro de tudo, faça o [download](https://golang.org/dl/) e instale o Go. É necessário a versão `1.11` ou superior.
2020-02-11 00:31:49 +00:00
A instalação é feita usando o comando [`go get`](https://golang.org/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them) :
```bash
2020-03-01 08:44:10 +01:00
go get -u github.com/gofiber/fiber/...
2020-02-11 00:31:49 +00:00
```
## 🤖 Benchmarks
2020-02-11 21:17:02 -03:00
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) .
2020-02-11 00:31:49 +00:00
<p float="left" align="middle">
2020-02-11 02:31:22 +01:00
<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%">
2020-02-11 00:31:49 +00:00
</p>
## 🎯 Recursos
- [Roteamento](https://fiber.wiki/routing) robusto
- Servir [arquivos estáticos](https://fiber.wiki/application#static)
- [Desempenho](https://fiber.wiki/benchmarks) extremo
2020-02-11 21:17:02 -03:00
- [Baixo consumo de memória](https://fiber.wiki/benchmarks)
- [API de rotas](https://fiber.wiki/context)
2020-02-11 00:31:49 +00:00
- Suporte para Middleware e [Next](https://fiber.wiki/context#next)
2020-02-11 21:17:02 -03:00
- 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
- Traduzido em [5 idiomas](https://fiber.wiki/)
2020-02-11 00:31:49 +00:00
- E muito mais, [explore o Fiber](https://fiber.wiki/)
## 💡 Filosofia
2020-02-11 21:17:02 -03:00
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.
2020-02-11 00:31:49 +00:00
2020-02-11 21:17:02 -03:00
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ê.
2020-02-11 00:31:49 +00:00
## 👀 Exemplos
2020-02-11 21:17:02 -03:00
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).
2020-02-11 00:31:49 +00:00
2020-02-16 18:00:14 +01:00
### Routing
2020-02-11 00:31:49 +00:00
2020-02-16 18:00:14 +01:00
```go
func main() {
app := fiber.New()
2020-02-11 00:31:49 +00:00
2020-02-16 18:00:14 +01:00
// GET /john
app.Get("/:name", func(c *fiber.Ctx) {
fmt.Printf("Hello %s!", c.Params("name"))
// => Hello john!
})
2020-02-11 00:31:49 +00:00
2020-02-16 18:00:14 +01:00
// 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:
})
2020-02-11 00:31:49 +00:00
2020-02-16 18:00:14 +01:00
// GET /api/register
app.Get("/api*", func(c *fiber.Ctx) {
fmt.Printf("/api%s", c.Params("*"))
// => /api/register
})
2020-02-11 00:31:49 +00:00
2020-02-16 18:00:14 +01:00
app.Listen(3000)
}
```
2020-02-11 00:31:49 +00:00
2020-03-04 13:55:12 +01:00
### Serve static files
https://fiber.wiki/application#static
```go
func main() {
app := fiber.New()
2020-02-11 00:31:49 +00:00
2020-03-04 13:55:12 +01:00
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
2020-02-16 18:00:14 +01:00
```go
func main() {
app := fiber.New()
// Match any route
app.Use(func(c *fiber.Ctx) {
fmt.Println("First middleware")
c.Next()
})
2020-02-11 00:31:49 +00:00
2020-02-16 18:00:14 +01:00
// Match all routes starting with /api
app.Use("/api", func(c *fiber.Ctx) {
fmt.Println("Second middleware")
c.Next()
})
2020-02-11 00:31:49 +00:00
2020-02-16 18:00:14 +01:00
// POST /api/register
app.Post("/api/register", func(c *fiber.Ctx) {
fmt.Println("Last middleware")
c.Send("Hello, World!")
})
2020-02-11 00:31:49 +00:00
2020-02-16 18:00:14 +01:00
app.Listen(3000)
}
```
2020-02-11 00:31:49 +00:00
2020-02-14 02:24:06 +01:00
<details>
2020-03-04 13:55:12 +01:00
<summary>📚 Show more code examples</summary>
### Template engines
https://fiber.wiki/application#settings
https://fiber.wiki/context#render
Supported engines:
- [html](https://golang.org/pkg/html/template/)
- [amber](https://github.com/eknkc/amber)
- [handlebars](https://github.com/aymerick/raymond)
- [mustache](https://github.com/cbroglie/mustache)
- [pug](https://github.com/Joker/jade)
```go
func main() {
// You can setup template engine before initiation app:
app := fiber.New(&fiber.Settings{
TemplateEngine: "mustache",
TemplateFolder: "./views",
TemplateExtension: ".tmpl",
})
// OR after initiation app at any convenient location:
app.Settings.TemplateEngine = "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/fiber/middleware"
)
func main() {
app := fiber.New()
// If you want to change default Logger config
loggerConfig := middleware.LoggerConfig{
Format: "${time} - ${method} ${path}\n",
TimeFormat: "Mon, 2 Jan 2006 15:04:05 MST",
}
// Middleware for Logger with config
app.Use(middleware.Logger(loggerConfig))
// ...
}
```
### Cross-Origin Resource Sharing (CORS)
https://fiber.wiki/middleware#cors
[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is a mechanism that uses additional HTTP headers to tell browsers to give a web application running at one origin, access to selected resources from a different origin. A web application executes a cross-origin HTTP request when it requests a resource that has a different origin (domain, protocol, or port) from its own.
```go
import (
"github.com/gofiber/fiber"
"github.com/gofiber/fiber/middleware"
)
func main() {
app := fiber.New()
// Connect CORS for each route as middleware
app.Use(middleware.CORS())
app.Get("/", func(c *fiber.Ctx) {
c.Send("CORS is enabled!")
})
app.Listen(3000)
}
```
Check CORS by passing any domain in `Origin` header:
```bash
curl -H "Origin: http://example.com" --verbose http://localhost:3000
```
2020-02-11 00:31:49 +00:00
2020-02-16 18:00:14 +01:00
### Custom 404 response
2020-02-11 00:31:49 +00:00
2020-02-16 18:00:14 +01:00
```go
func main() {
app := fiber.New()
2020-02-11 00:31:49 +00:00
2020-02-16 18:00:14 +01:00
app.Static("/public")
2020-03-04 13:55:12 +01:00
2020-02-16 18:00:14 +01:00
app.Get("/demo", func(c *fiber.Ctx) {
c.Send("This is a demo!")
})
2020-03-04 13:55:12 +01:00
2020-02-16 18:00:14 +01:00
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)
}
```
2020-02-11 00:31:49 +00:00
2020-02-16 18:00:14 +01:00
### JSON Response
2020-03-04 13:55:12 +01:00
https://fiber.wiki/context#json
2020-02-16 18:00:14 +01:00
```go
2020-03-04 13:55:12 +01:00
type User struct {
Name string `json:"name"`
Age int `json:"age"`
}
2020-02-16 18:00:14 +01:00
func main() {
app := fiber.New()
2020-03-04 13:55:12 +01:00
app.Get("/user", func(c *fiber.Ctx) {
c.JSON(&User{"John", 20})
// {"name":"John", "age":20}
})
2020-02-11 00:31:49 +00:00
2020-02-16 18:00:14 +01:00
app.Get("/json", func(c *fiber.Ctx) {
2020-03-04 13:55:12 +01:00
c.JSON(&fiber.Map{
"success": true,
"message": "Hi John!",
})
// {"success":true, "message":"Hi John!"}
2020-02-16 18:00:14 +01:00
})
2020-02-11 00:31:49 +00:00
2020-02-16 18:00:14 +01:00
app.Listen(3000)
}
```
2020-02-11 00:31:49 +00:00
2020-03-04 13:55:12 +01:00
### WebSocket support
https://fiber.wiki/application#websocket
```go
func main() {
app := fiber.New()
2020-02-14 02:05:39 +01:00
2020-03-04 13:55:12 +01:00
app.WebSocket("/ws", func(c *fiber.Conn) {
for {
mt, msg, err := c.ReadMessage()
if err != nil {
log.Println("read:", err)
break
}
log.Printf("recovery: %s", msg)
err = c.WriteMessage(mt, msg)
if err != nil {
log.Println("write:", err)
break
}
}
})
2020-02-14 02:05:39 +01:00
2020-03-04 13:55:12 +01:00
// Listen on ws://localhost:3000/ws
app.Listen(3000)
}
```
### Recover middleware
https://fiber.wiki/middleware#recover
2020-02-16 18:00:14 +01:00
```go
2020-03-04 13:55:12 +01:00
package main
import (
"github.com/gofiber/fiber"
"github.com/gofiber/fiber/middleware"
)
2020-02-16 18:00:14 +01:00
func main() {
app := fiber.New()
2020-02-14 02:05:39 +01:00
2020-03-04 13:55:12 +01:00
app.Use(middleware.Recover(func(c *fiber.Ctx, err error) {
log.Println(err) // "Something went wrong!"
c.SendStatus(500) // Internal Server Error
})))
2020-02-16 18:00:14 +01:00
app.Get("/", func(c *fiber.Ctx) {
panic("Something went wrong!")
})
app.Listen(3000)
}
```
</details>
2020-02-14 02:05:39 +01:00
2020-02-11 00:31:49 +00:00
## 💬 Mídia
2020-02-11 21:17:02 -03:00
- [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_
2020-02-11 00:31:49 +00:00
2020-02-11 21:17:02 -03:00
## 👍 Contribuindo
2020-02-11 00:31:49 +00:00
2020-02-13 00:04:10 +03:00
Se você quer **agradecer** e/ou apoiar o desenvolvimento ativo do `Fiber`:
2020-02-11 00:31:49 +00:00
2020-02-11 21:17:02 -03:00
1. Deixe uma [estrela no GitHub](https://github.com/gofiber/fiber/stargazers) do projeto.
2020-02-11 00:31:49 +00:00
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) .
2020-02-11 21:17:02 -03:00
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.
2020-02-11 00:31:49 +00:00
2020-02-12 03:54:54 +01:00
## ☕ Supporters
2020-02-16 18:00:14 +01:00
<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>
2020-02-12 03:54:54 +01:00
<table>
<tr>
<td align="center">
2020-02-14 02:05:39 +01:00
<a href="https://github.com/bihe">
2020-02-16 18:00:14 +01:00
<img src="https://avatars1.githubusercontent.com/u/635852?s=460&v=4" width="100px"></br>
2020-02-14 02:05:39 +01:00
<sub><b>HenrikBinggl</b></sub>
2020-02-12 03:54:54 +01:00
</a>
2020-02-14 02:05:39 +01:00
</td>
<td align="center">
<a href="https://github.com/koddr">
2020-02-16 18:00:14 +01:00
<img src="https://avatars0.githubusercontent.com/u/11155743?s=460&v=4" width="100px"></br>
2020-02-14 02:05:39 +01:00
<sub><b>koddr</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/MarvinJWendt">
2020-02-16 18:00:14 +01:00
<img src="https://avatars1.githubusercontent.com/u/31022056?s=460&v=4" width="100px"></br>
2020-02-14 02:05:39 +01:00
<sub><b>MarvinJWendt</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/toishy">
2020-02-16 18:00:14 +01:00
<img src="https://avatars1.githubusercontent.com/u/31921460?s=460&v=4" width="100px"></br>
2020-02-14 02:05:39 +01:00
<sub><b>ToishY</b></sub>
</a>
</td>
2020-02-12 03:54:54 +01:00
</tr>
</table>
## ⭐️ Estrelas
2020-02-11 00:31:49 +00:00
<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>
## ⚠️ Licença
2020-02-13 00:04:10 +03:00
`Fiber` é um software livre e de código aberto licenciado sob a [Licença MIT](https://github.com/gofiber/fiber/blob/master/LICENSE).