api

Documentation

Overview

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

Index

• func LoggingMiddleware(svc orders.OrderService, logger log.Logger) orders.OrderService
• func MakeOrdersHandler(svc orders.OrderService, r *mux.Router, logger kitlog.Logger)
• func MetricsMiddleware(svc orders.OrderService, counter metrics.Counter, latency metrics.Histogram) orders.OrderService
• type Response

Functions

func LoggingMiddleware

func LoggingMiddleware(svc orders.OrderService, logger log.Logger) orders.OrderService

LoggingMiddleware adds logging facilities to the core service.

func MakeOrdersHandler

func MakeOrdersHandler(svc orders.OrderService, r *mux.Router, logger kitlog.Logger)

MakeOrdersHandler returns a HTTP handler for API endpoints.

func MetricsMiddleware

func MetricsMiddleware(svc orders.OrderService, counter metrics.Counter, latency metrics.Histogram) orders.OrderService

MetricsMiddleware instruments core service by tracking request count and latency.

Types

type Response

type Response interface {
	// Code returns HTTP response code.
	Code() int

	// Headers returns map of HTTP headers with their values.
	Headers() map[string]string

	// Empty indicates if HTTP response has content.
	Empty() bool
}

Response contains HTTP response specific methods.