fiber/docs/api/middleware/envvar.md

id	title
envvar	EnvVar

EnvVar middleware for Fiber that can be used to expose environment variables with various options.

Signatures

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

Examples

First import the middleware from Fiber,

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

Then create a Fiber app with app := fiber.New().

Note: You need to provide a path to use envvar middleware.

Default Config

app.Use("/expose/envvars", envvar.New())

Custom Config

app.Use("/expose/envvars", envvar.New(envvar.Config{
    ExportVars:  map[string]string{"testKey": "", "testDefaultKey": "testDefaultVal"},
    ExcludeVars: map[string]string{"excludeKey": ""}}
}))

Response

Http response contract:

{
  "vars": {
    "someEnvVariable": "someValue",
    "anotherEnvVariable": "anotherValue",
  }
}

Config

// Config defines the config for middleware.
type Config struct {
    // ExportVars specifies the environment variables that should export
    ExportVars map[string]string
    // ExcludeVars specifies the environment variables that should not export
    ExcludeVars map[string]string
}

Default Config

Config{}