requestid.md

RequestID

RequestID middleware for Fiber that adds an indentifier to the response.

Table of Contents

• Signatures
• Examples
• Config
• Default Config

Signatures

func New(config ...Config) fiber.Handler

Examples

Import the middleware package that is part of the Fiber web framework

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

After you initiate your Fiber app, you can use the following possibilities:

// Default middleware config
app.Use(requestid.New())

// Or extend your config for customization
app.Use(requestid.New(requestid.Config{
    Header:    "X-Custom-Header",
    Generator: func() string {
        return "static-id"
    },
}))

Config

// Config defines the config for middleware.
type Config struct {
    // Next defines a function to skip this middleware when returned true.
    //
    // Optional. Default: nil
    Next func(c *fiber.Ctx) bool

    // Header is the header key where to get/set the unique request ID
    //
    // Optional. Default: "X-Request-ID"
    Header string

    // Generator defines a function to generate the unique identifier.
    //
    // Optional. Default: utils.UUID
    Generator func() string

    // ContextKey defines the key used when storing the request ID in
    // the locals for a specific request.
    //
    // Optional. Default: requestid
    ContextKey string
}

Default Config

var ConfigDefault = Config{
    Next:       nil,
    Header:     fiber.HeaderXRequestID,
    Generator:  func() string {
        return utils.UUID()
    },
    ContextKey: "requestid"
}