H0llyW00dzZ/fiber
H0llyW00dzZ/fiber
1
0
Fork 0
mirror of https://github.com/gofiber/fiber.git synced 2025-02-23 12:24:02 +00:00
Code Releases Activity
fiber/.github/README_fr.md
Ender Bonnet 0abe10e3d7 Doc: Add media tutorial on spanish
2020-06-26 21:52:29 -04:00

33 KiB
Raw Blame History

Fiber

Fiber est un framework web inspiré d' Express. Il se base sur Fasthttp, l'implémentation HTTP de Go la plus rapide. Conçu pour faciliter les choses pour des développements rapides, Fiber garde à l'esprit l'absence d'allocations mémoires, ainsi que les performances.

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

🤖 Benchmarks

Ces tests sont effectués par TechEmpower et Go Web. Si vous voulez voir tous les résultats, n'hésitez pas à consulter notre Wiki.

⚙️ Installation

Premièrement, téléchargez et installez Go. Version 1.11 ou supérieur requise.

L'installation est ensuite lancée via la commande go get:

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

🎯 Features

💡 Philosophie

Les nouveaux gophers qui passent de Node.js à Go sont confrontés à une courbe d'apprentissage, avant de pouvoir construire leurs applications web et microservices. Fiber, en tant que framework web, a été mis au point avec en tête l'idée de minimalisme, tout en suivant l'UNIX way, afin que les nouveaux gophers puissent rapidement entrer dans le monde de Go, avec un accueil chaleureux, de confiance.

Fiber est inspiré par Express, le framework web le plus populaire d'Internet. Nous avons combiné la facilité d'Express, et la performance brute de Go. Si vous avez déja développé une application web en Node.js (en utilisant Express ou équivalent), alors de nombreuses méthodes et principes vous sembleront familiers.

👀 Exemples

Ci-dessous quelques exemples courants. Si vous voulez voir plus d'exemples, rendez-vous sur notre "Recipes repository" ou visitez notre documentation API.

Routing

📖 Routing

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 /plantae/prunus.persica
  app.Get("/plantae/:genus.:species", func(c *fiber.Ctx) {
    fmt.Printf("Genius: %s, Species: %s", c.Params("genus"), c.Params("species"))
    // => Genius: prunus, Species: persica
  })

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

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

  app.Listen(3000)
}

Serve static files

📖 Static

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

📖 Middleware
📖 Next

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)
}
📚 Show more code examples

Views engines

📖 Settings
📖 Engines
📖 Render

Fiber defaults to the html/template when no view engine is set.

If you want to execute partials or use a different engine like amber, handlebars, mustache or pug etc..

Checkout our Template package that support multiple view engines.

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

  // ...
}

Grouping routes into chains

📖 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](https://docs.gofiber.io/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:

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

Custom 404 response

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

JSON Response

📖 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 Upgrade

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

Recover middleware

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

🧬 Fiber Middleware

The Fiber middleware modules listed here are maintained by the Fiber team.

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. -
embed FileServer 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! -

🌱 Third Party Middlewares

This is a list of middlewares that are created by the Fiber community, please create a PR if you want to see yours!

💬 Media

👍 Contribuer

Si vous voulez nous remercier et/ou soutenir le développement actif de Fiber:

  1. Ajoutez une GitHub Star à ce projet.
  2. Twittez à propos de ce projet sur votre Twitter.
  3. Ecrivez un article (review, tutorial) sur Medium, Dev.to, ou encore un blog personnel.
  4. Help us to translate our API Documentation via Crowdin Crowdin
  5. Support the project by donating a cup of coffee.

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

‎‍💻 Code Contributors

Code Contributors

⭐️ Stargazers

Stargazers over time

⚠️ License

Copyright (c) 2019-present Fenny and Contributors. Fiber is free and open-source software licensed under the MIT License. Official logo was created by Vic Shóstak and distributed under Creative Commons license (CC BY-SA 4.0 International).

Third-party library licenses