mirror of https://github.com/gofiber/fiber.git synced 2025-05-31 11:52:41 +00:00

Juan Calderon-Perez 9463a8f626

v3: Add support for consistent documentation using markdownlint (#3064 )

* Add support for consistent documentation using markdownlint

* Only run workflow during changes to markdown files

* Fix more inconsistencies

* Fixes to markdown under .github/

* More fixes

* Apply suggestions from code review

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Fix typo in limiter docs

* Add missing space before code-block

* Add check for dead-links

* Add write-good

* Remove legacy README files

* Fix glob for skipping .md files

* Use paths-ignore instead

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

2024-07-11 15:21:56 +02:00

3.7 KiB

Raw Blame History

id
adaptor

Adaptor

Converter for net/http handlers to/from Fiber request handlers, special thanks to @arsmn!

Signatures

Name	Signature	Description
HTTPHandler	`HTTPHandler(h http.Handler) fiber.Handler`	http.Handler -> fiber.Handler
HTTPHandlerFunc	`HTTPHandlerFunc(h http.HandlerFunc) fiber.Handler`	http.HandlerFunc -> fiber.Handler
HTTPMiddleware	`HTTPHandlerFunc(mw func(http.Handler) http.Handler) fiber.Handler`	func(http.Handler) http.Handler -> fiber.Handler
FiberHandler	`FiberHandler(h fiber.Handler) http.Handler`	fiber.Handler -> http.Handler
FiberHandlerFunc	`FiberHandlerFunc(h fiber.Handler) http.HandlerFunc`	fiber.Handler -> http.HandlerFunc
FiberApp	`FiberApp(app *fiber.App) http.HandlerFunc`	Fiber app -> http.HandlerFunc
ConvertRequest	`ConvertRequest(c fiber.Ctx, forServer bool) (*http.Request, error)`	fiber.Ctx -> http.Request
CopyContextToFiberContext	`CopyContextToFiberContext(context any, requestContext *fasthttp.RequestCtx)`	context.Context -> fasthttp.RequestCtx

Examples

net/http to Fiber

package main

import (
    "fmt"
    "net/http"

    "github.com/gofiber/fiber/v3"
    "github.com/gofiber/fiber/v3/middleware/adaptor"
)

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

    // http.Handler -> fiber.Handler
    app.Get("/", adaptor.HTTPHandler(handler(greet)))

    // http.HandlerFunc -> fiber.Handler
    app.Get("/func", adaptor.HTTPHandlerFunc(greet))

    // Listen on port 3000
    app.Listen(":3000")
}

func handler(f http.HandlerFunc) http.Handler {
    return http.HandlerFunc(f)
}

func greet(w http.ResponseWriter, r *http.Request) {
    fmt.Fprint(w, "Hello World!")
}

net/http middleware to Fiber

package main

import (
    "log"
    "net/http"

    "github.com/gofiber/fiber/v3"
    "github.com/gofiber/fiber/v3/middleware/adaptor"
)

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

    // http middleware -> fiber.Handler
    app.Use(adaptor.HTTPMiddleware(logMiddleware))

    // Listen on port 3000
    app.Listen(":3000")
}

func logMiddleware(next http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        log.Println("log middleware")
        next.ServeHTTP(w, r)
    })
}

Fiber Handler to net/http

package main

import (
    "net/http"

    "github.com/gofiber/fiber/v3"
    "github.com/gofiber/fiber/v3/middleware/adaptor"
)

func main() {
    // fiber.Handler -> http.Handler
    http.Handle("/", adaptor.FiberHandler(greet))

      // fiber.Handler -> http.HandlerFunc
    http.HandleFunc("/func", adaptor.FiberHandlerFunc(greet))

    // Listen on port 3000
    http.ListenAndServe(":3000", nil)
}

func greet(c fiber.Ctx) error {
    return c.SendString("Hello World!")
}

Fiber App to net/http

package main

import (
    "net/http"

    "github.com/gofiber/fiber/v3"
    "github.com/gofiber/fiber/v3/middleware/adaptor"
)

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

    app.Get("/greet", greet)

    // Listen on port 3000
    http.ListenAndServe(":3000", adaptor.FiberApp(app))
}

func greet(c fiber.Ctx) error {
    return c.SendString("Hello World!")
}

Fiber Context to (net/http).Request

package main

import (
    "net/http"

    "github.com/gofiber/fiber/v3"
    "github.com/gofiber/fiber/v3/middleware/adaptor"
)

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

    app.Get("/greet", greetWithHTTPReq)

    // Listen on port 3000
    http.ListenAndServe(":3000", adaptor.FiberApp(app))
}

func greetWithHTTPReq(c fiber.Ctx) error {
    httpReq, err := adaptor.ConvertRequest(c, false)
    if err != nil {
        return err
    }

    return c.SendString("Request URL: " + httpReq.URL.String())
}

3.7 KiB Raw Blame History