api

Documentation

Index

• func Health(c *fiber.Ctx) error
• func NewMetricsMiddleware(collector metrics_collector.HttpApiMetrics) fiber.Handler
• type Api
  • func New(logger *zap.Logger, middlewareCollector metrics.HttpApiMetrics, ...) Api
• type Message
• type Provider

Functions

func Health

func Health(c *fiber.Ctx) error

Health godoc @Summary Health route @Description Health route @Accept json @Produce json @Success 200 {object} Message @Router /v1/healthz [get] @Tags health get route.

func NewMetricsMiddleware

func NewMetricsMiddleware(collector metrics_collector.HttpApiMetrics) fiber.Handler

Types

type Api

type Api interface {
	Listen(port string) error
	Test(req *http.Request, msTimeout ...int) (resp *http.Response, err error)
}

func New

func New(logger *zap.Logger, middlewareCollector metrics.HttpApiMetrics, provider provider.Provider) Api

type Message

type Message struct {
	Message string `json:"message"`
}

type Provider

type Provider interface {
	provider.Provider
}