api

package

v0.1.0 Latest Latest Go to latest Published: Jul 14, 2023 License: Apache-2.0 Imports: 21 Imported by: 0

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 PropertiesValuesEqualsResponse
type PropertyValuesEqualsRequest
type Provider

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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 PropertiesValuesEqualsResponse ¶

type PropertiesValuesEqualsResponse struct {
	Equals bool `json:"equals"`
}

PropertiesValuesEqualsResponse holds params for property values equals response.

type PropertyValuesEqualsRequest ¶

type PropertyValuesEqualsRequest struct {
	Name     string `json:"name"`
	Previous string `json:"previous"`
	Current  string `json:"current"`
}

PropertyValuesEqualsRequest holds params for property values equals request.

type Provider ¶

type Provider interface {
	provider.Provider
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
mock Package mock_api is a generated GoMock package.	Package mock_api is a generated GoMock package.

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