api

package

v0.0.1 Latest Latest Go to latest Published: Oct 16, 2020 License: Apache-2.0 Imports: 20 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gitee.com/shtemmi/iotflux

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 ¶

View Source

const MailSent = "Email with reset link is sent"

MailSent message response when link is sent

Variables ¶

View Source

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.

Types ¶

This section is empty.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
http Package http contains implementation of users service HTTP API.	Package http contains implementation of users service HTTP API.

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