infra

Documentation

Index

• type Ping
• type PingEndpoint
  • func NewPingEndpoint() *PingEndpoint
  • func (p *PingEndpoint) Ping(c *gin.Context)
  • func (p *PingEndpoint) RegisterRoutes(r gin.IRoutes)
• type RateLimiter
  • func NewRateLimiter(requestsPerSecond float64) *RateLimiter
  • func (r *RateLimiter) Handler() gin.HandlerFunc

Types

type Ping

type Ping struct {
	// example: pong
	Message string `json:"message"`
}

Ping represents ping response swagger:model

type PingEndpoint

type PingEndpoint struct {
}

PingEndpoint responds to ping

func NewPingEndpoint

func NewPingEndpoint() *PingEndpoint

NewPingEndpoint creates ping endpoint

func (*PingEndpoint) Ping

func (p *PingEndpoint) Ping(c *gin.Context)

Ping check service health

@Tags health @Summary Check service health @Description Endpoint is meant to check service health and returns pong response for every request @Accept json @Produce json @Success 200 {object} infra.Ping @Router /v1/ping [get]

func (*PingEndpoint) RegisterRoutes

func (p *PingEndpoint) RegisterRoutes(r gin.IRoutes)

RegisterRoutes registers ping route

type RateLimiter

type RateLimiter struct {
	// contains filtered or unexported fields
}

RateLimiter limits requests to certain endpoints

func NewRateLimiter

func NewRateLimiter(requestsPerSecond float64) *RateLimiter

NewRateLimiter creates a new RateLimiter

func (*RateLimiter) Handler

func (r *RateLimiter) Handler() gin.HandlerFunc

Handler returns handler func for gin