mirror of
https://github.com/gofiber/fiber.git
synced 2025-05-31 11:52:41 +00:00
87faeda5c1
* Fix: EnvVar middleware parses base64 incorrectly * Chore: fix typo in README.md * Chore: standardize and simplify response
84 lines
1.7 KiB
Markdown
84 lines
1.7 KiB
Markdown
# Exposing Environment Variables Middleware
|
|
|
|
EnvVar middleware for [Fiber](https://github.com/gofiber/fiber) that can be used to expose environment variables with various options.
|
|
|
|
## Table of Contents
|
|
|
|
- [Environment Variables (EnvVar) Middleware](#environment-variables-envvar-middleware)
|
|
- [Table of Contents](#table-of-contents)
|
|
- [Signatures](#signatures)
|
|
- [Examples](#examples)
|
|
- [Default Config](#default-config)
|
|
- [Custom Config](#custom-config)
|
|
- [Response](#response)
|
|
- [Config](#config)
|
|
- [Default Config](#default-config-1)
|
|
|
|
## Signatures
|
|
|
|
```go
|
|
func New(config ...Config) fiber.Handler
|
|
```
|
|
|
|
## Examples
|
|
|
|
First import the middleware from Fiber,
|
|
|
|
```go
|
|
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
|
|
|
|
```go
|
|
app.Use("/expose/envvars", envvar.New())
|
|
```
|
|
|
|
### Custom Config
|
|
|
|
```go
|
|
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
|
|
|
|
```go
|
|
// 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
|
|
|
|
```go
|
|
Config{}
|
|
```
|