status

package
v0.0.0-...-f7f2675 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 20, 2023 License: GPL-3.0 Imports: 1 Imported by: 0

Documentation

Overview

Package status implementation all handler for Status API

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func HealthCheck

func HealthCheck(c *fiber.Ctx) error

HealthCheck is an HTTP handler function that returns a "No Content" response to indicate that the API is running and healthy. It is typically used as a "health check" endpoint that can be polled by monitoring systems to verify that the API is functioning correctly. Parameters: - c: a pointer to the fiber.Ctx object representing the HTTP request context. Returns: - an error value, which is always nil, since there is no meaningful error condition for this endpoint. @Summary Show the status of server. @Description get the status of server. @Tags Status @Accept */* @Produce json @Success 204 {object} nil @Router /api/v1/status/healthcheck [get]

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL