Skip to content

Latest commit

 

History

History
636 lines (493 loc) · 41.4 KB

README_es.md

File metadata and controls

636 lines (493 loc) · 41.4 KB

Fiber

Fiber es un framework web inspirado en Express construido sobre Fasthttp, el motor HTTP más rápido para Go. Diseñado para facilitar las cosas para un desarrollo rápido con cero asignación de memoria y rendimiento en mente.

⚡️ Inicio rápido

package main

import "github.com/gofiber/fiber/v2"

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

    app.Get("/", func(c *fiber.Ctx) error {
        return c.SendString("Hello, World 👋!")
    })

    app.Listen(":3000")
}

🤖 Puntos de referencia

Estas pruebas son realizadas por TechEmpower y Go Web. Si desea ver todos los resultados, visite nuestra Wiki.

⚙️ Instalación

Asegúrese de tener instalado Go (descargar). Versión 1.14 o superior.

Arranque su proyecto creando una nueva carpeta y ejecutando go mod init github.com/your/repo (mas información) dentro del mismo directorio. Después instale Fiber mediante el comando go get:

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

🎯 Características

💡 Filosofía

Los nuevos gophers que hacen el cambio de Node.js a Go están lidiando con una curva de aprendizaje antes de que puedan comenzar a construir sus aplicaciones web o micro-servicios. Fiber, como un marco web , fue creado con la idea del minimalismo y sigue el camino de UNIX , para que los nuevos gophers puedan ingresar rápidamente al mundo de Go con una cálida y confiable bienvenida.

Fiber está inspirado en Expressjs, el framework web más popular en Internet. Combinamos la facilidad de Express y el rendimiento bruto de Go. Si alguna vez ha implementado una aplicación web en Node.js ( utilizando Express.js o similar ), muchos métodos y principios le parecerán muy comunes .

⚠️ Limitantes

  • Debido a que Fiber utiliza unsafe, la biblioteca no siempre será compatible con la última versión de Go. Fiber 2.18.0 ha sido probado con las versiones de Go 1.14 a 1.17.
  • Fiber no es compatible con interfaces net/http. Esto significa que no lo podrá usar en proyectos como qglgen, go-swagger, u otros que son parte del ecosistema net/http.

👀 Ejemplos

A continuación se enumeran algunos de los ejemplos comunes. Si desea ver más ejemplos de código, visite nuestro repositorio de Recetas o nuestra documentación de API .

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

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

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

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

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

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

    log.Fatal(app.Listen(":3000"))
}
func main() {
    app := fiber.New()

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

    data, _ := json.MarshalIndent(app.GetRoute("api"), "", "  ")
    fmt.Print(string(data))
    // Prints:
    // {
    //    "method": "GET",
    //    "name": "api",
    //    "path": "/api/*",
    //    "params": [
    //      "*1"
    //    ]
    // }


    log.Fatal(app.Listen(":3000"))
}
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

    log.Fatal(app.Listen(":3000"))
}
func main() {
	app := fiber.New()

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

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

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

	log.Fatal(app.Listen(":3000"))
}
📚 Mostrar más ejemplos de código

Motores de Vistas

📖 Configuración 📖 Motores 📖 Renderizado

El motor por defecto de Fiber, cuando no es especificado, es html/template.

Si quiere ejecutar vistas parciales, o usar un motor diferente (como amber, handlebars, mustache o pug, etc).

Revise nuestro paquete para Plantillas que soporta múltiples motores de vistas.

package main

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

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

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

    log.Fatal(app.Listen(":3000"))
}

Agrupando rutas en cadenas

📖 Group

func middleware(c *fiber.Ctx) error {
    fmt.Println("Don't mind me!")
    return c.Next()
}

func handler(c *fiber.Ctx) error {
    return c.SendString(c.Path())
}

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

    // Root API route
    api := app.Group("/api", middleware) // /api

    // API v1 routes
    v1 := api.Group("/v1", middleware) // /api/v1
    v1.Get("/list", handler)           // /api/v1/list
    v1.Get("/user", handler)           // /api/v1/user

    // API v2 routes
    v2 := api.Group("/v2", middleware) // /api/v2
    v2.Get("/list", handler)           // /api/v2/list
    v2.Get("/user", handler)           // /api/v2/user

    // ...
}

Middleware logger

📖 Logger

package main

import (
    "log"

    "github.com/gofiber/fiber/v2"
    "github.com/gofiber/fiber/v2/middleware/logger"
)

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

    app.Use(logger.New())

    // ...

    log.Fatal(app.Listen(":3000"))
}

Intercambio de recursos de origen cruzado (CORS)

📖 CORS

import (
    "log"

    "github.com/gofiber/fiber/v2"
    "github.com/gofiber/fiber/v2/middleware/cors"
)

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

    app.Use(cors.New())

    // ...

    log.Fatal(app.Listen(":3000"))
}

Revisar CORS, pasando cualquier dominio en el encabezado Origin:

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

Respuesta 404 personalizada

📖 HTTP Methods

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

    app.Static("/", "./public")

    app.Get("/demo", func(c *fiber.Ctx) error {
        return c.SendString("This is a demo!")
    })

    app.Post("/register", func(c *fiber.Ctx) error {
        return c.SendString("Welcome!")
    })

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

    log.Fatal(app.Listen(":3000"))
}

Respuesta 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) error {
        return c.JSON(&User{"John", 20})
        // => {"name":"John", "age":20}
    })

    app.Get("/json", func(c *fiber.Ctx) error {
        return c.JSON(fiber.Map{
            "success": true,
            "message": "Hi John!",
        })
        // => {"success":true, "message":"Hi John!"}
    })

    log.Fatal(app.Listen(":3000"))
}

Actualización a WebSockets

📖 Websocket

import (
    "github.com/gofiber/fiber/v2"
    "github.com/gofiber/fiber/v2/middleware/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
      }
    }
  }))

  log.Fatal(app.Listen(":3000"))
  // ws://localhost:3000/ws
}

Middleware de Recuperación

📖 Recover

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

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

    app.Use(recover.New())

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

    log.Fatal(app.Listen(":3000"))
}

🧬 Middleware Interno

Aquí está una lista del middleware incluido en el marco web Fiber.

Middleware Descripción
basicauth Autenticación básica usando HTTP. Llama al siguiente controlador si las credenciales son válidas, de lo contrario regresa un 401 Sin Autorización.
compress Middleware de compresión para Fiber, soporta deflate, gzip y brotli por defecto.
cache Intercepta y realiza cacheo de respuestas.
cors Habilita el intercambio de recursos de origen cruzado (CORS) con varias opciones.
csrf Protege de explotación por CSRF.
filesystem Middleware del sistema de archivos (FileSystem) para Fiber, agradecimiento especial y el crédito es de Alireza Salary.
favicon Ignora el favicon de los registros y lo sirve desde memoria si se proporciona la ruta de un archivo.
limiter Middleware para limitar las llamadas. Es posible usarlo para limitar peticiones repetidas a APIs públicos, o rutas para re-establecer contraseñas.
logger Registro de peticiones y respuestas HTTP.
pprof Agradecimiento especial a Matthew Lee (@mthli).
proxy Permite generar un proxy para peticiones a múltiples servidores.
requestid Agregar el id de la petición (requestid) a todas las peticiones.
recover Recupera de llamadas de pánico en cualquier parte de la traza de cadenas, y le otorga el control al ErrorHandler central.
timeout Agregar un tiempo máximo por petición, y lo remite al ErrorHandler si es excedido.

🧬 Middleware Externo

Lista de módulos de middleware alojados externamente, y mantenidos por el equipo de Fiber.

Middleware Descripción
adaptor Convierte controladores net/http de/hacía controladores de repuesta de Fiber ¡agradecimiento especial a @arsmn!
helmet Ayuda a asegurar sus aplicaciones a través de varios encabezados HTTP.
jwt Regresa autenticación tipo JSON Web Token (JWT).
keyauth Provee de autenticación a través de una llave.
rewrite Reescribe la ruta del URL basado en reglas previamente proveidas. Puede ser útil para mantener compatibilidad con versiones anteriores, o para crear hiper-vínculos claros y más descriptivos.
session Este middleware de sesiones está construido sobre fasthttp/session por @savsgio MIT. Agradecimiento especial a @thomasvvugt por la ayuda.
template Este paquete contiene ocho motores de plantillas que pueden ser usados con Fiber v1.10.x, requiere la versión de Go 1.13 o superior.
websocket Basado en WebSocket de Fasthttp para Fiber, con soporte para Locals.

🌱 Middlewares de Terceros

La siguiente es una lista de los proyectos de middleware creados por la comunidad de Fiber ¡Por favor crea un PR si quiere ver el suyo aquí!

👍 Contribuir

Si quiere agradecer y/o apoyar el desarrollo activo de Fiber:

  1. Agrega una estrella de GitHub al proyecto.
  2. Tuitea sobre el proyecto en tu Twitter.
  3. Escribe una reseña o tutorial en Medium , Dev.to o blog personal.
  4. Apoya el proyecto donando una tasa de café.

☕ Personas que han mostrado su apoyo

Fiber es un proyecto de código abierto que se mantiene a través de donaciones para pagar las cuentas e.g. nuestro nombre de dominio, gitbook, netlify y hosting serverless. Si quieres apoyar a Fiber, puedes ☕ comprar un 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

‎‍💻 Contribuyentes de código

Code Contributors

⭐️ Stargazers

Stargazers over time

⚠️ Licencia

Copyright (c) 2019-presente Fenny y contribuyentes. Fiber es software libre y de código abierto bajo la licencia MIT. El logo oficial fue creado por Vic Shóstak y distribuido bajo la licencia Creative Commons (CC BY-SA 4.0 International).

Third-party library licenses