mirror of
https://github.com/gofiber/fiber.git
synced 2025-05-30 03:12:39 +00:00
9463a8f626
* 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>
71 lines
1.6 KiB
Markdown
71 lines
1.6 KiB
Markdown
---
|
|
id: envvar
|
|
---
|
|
|
|
# EnvVar
|
|
|
|
EnvVar middleware for [Fiber](https://github.com/gofiber/fiber) that can be used to expose environment variables with various options.
|
|
|
|
## Signatures
|
|
|
|
```go
|
|
func New(config ...Config) fiber.Handler
|
|
```
|
|
|
|
## Examples
|
|
|
|
Import the middleware package that is part of the Fiber web framework
|
|
|
|
```go
|
|
import (
|
|
"github.com/gofiber/fiber/v3"
|
|
"github.com/gofiber/fiber/v3/middleware/envvar"
|
|
)
|
|
```
|
|
|
|
After you initiate your Fiber app, you can use the following possibilities:
|
|
|
|
```go
|
|
// Initialize default config
|
|
app.Use("/expose/envvars", envvar.New())
|
|
|
|
// Or extend your config for customization
|
|
app.Use("/expose/envvars", envvar.New(
|
|
envvar.Config{
|
|
ExportVars: map[string]string{"testKey": "", "testDefaultKey": "testDefaultVal"},
|
|
ExcludeVars: map[string]string{"excludeKey": ""},
|
|
}),
|
|
)
|
|
```
|
|
|
|
:::note
|
|
You will need to provide a path to use the envvar middleware.
|
|
:::
|
|
|
|
## Response
|
|
|
|
Http response contract:
|
|
|
|
```json
|
|
{
|
|
"vars": {
|
|
"someEnvVariable": "someValue",
|
|
"anotherEnvVariable": "anotherValue",
|
|
}
|
|
}
|
|
|
|
```
|
|
|
|
## Config
|
|
|
|
| Property | Type | Description | Default |
|
|
|:------------|:--------------------|:-----------------------------------------------------------------------------|:--------|
|
|
| ExportVars | `map[string]string` | ExportVars specifies the environment variables that should be exported. | `nil` |
|
|
| ExcludeVars | `map[string]string` | ExcludeVars specifies the environment variables that should not be exported. | `nil` |
|
|
|
|
## Default Config
|
|
|
|
```go
|
|
Config{}
|
|
```
|