Skip to content

Commit

Permalink
Add docs from gofiber/fiber@476e1ed
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 5, 2024
1 parent ca6740a commit 300e94a
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/core/api/middleware/healthcheck.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
id: healthcheck
title: healthcheck
---

# Health Check

Liveness and readiness probes middleware for [Fiber](https://github.com/gofiber/fiber) that provides two endpoints for checking the liveness and readiness state of HTTP applications.

## Overview
Expand All @@ -27,15 +28,15 @@ func New(config Config) fiber.Handler

## Examples

Import the middleware package that is part of the Fiber web framework
Import the middleware package that is part of the [Fiber](https://github.com/gofiber/fiber) web framework
```go
import (
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/healthcheck"
)
```

After you initiate your Fiber app, you can use the following possibilities:
After you initiate your [Fiber](https://github.com/gofiber/fiber) app, you can use the following possibilities:

```go
// Provide a minimal config
Expand Down Expand Up @@ -102,4 +103,4 @@ var ConfigDefault = Config{
LivenessEndpoint: "/livez",
ReadinessEndpoint: "/readyz",
}
```
```

0 comments on commit 300e94a

Please sign in to comment.