api

Documentation

Overview

Package api contains API-related concerns: endpoint definitions, middlewares and all resource representations.

Index

• Constants
• Variables
• func LoggingMiddleware(svc users.Service, logger log.Logger) users.Service
• func MakeHandler(svc users.Service, tracer opentracing.Tracer, l log.Logger) http.Handler
• func MetricsMiddleware(svc users.Service, counter metrics.Counter, latency metrics.Histogram) users.Service

Constants

const MailSent = "Email with reset link is sent"

MailSent message response when link is sent

Variables

var (

	// ErrUnsupportedContentType indicates unacceptable or lack of Content-Type
	ErrUnsupportedContentType = errors.New("unsupported content type")

	// ErrFailedDecode indicates failed to decode request body
	ErrFailedDecode = errors.New("failed to decode request body")
)

Functions

func LoggingMiddleware

func LoggingMiddleware(svc users.Service, logger log.Logger) users.Service

LoggingMiddleware adds logging facilities to the core service.

func MakeHandler

func MakeHandler(svc users.Service, tracer opentracing.Tracer, l log.Logger) http.Handler

MakeHandler returns a HTTP handler for API endpoints.

func MetricsMiddleware

func MetricsMiddleware(svc users.Service, counter metrics.Counter, latency metrics.Histogram) users.Service

MetricsMiddleware instruments core service by tracking request count and latency.