api

Documentation

Index

• func Register(rootRouter *mux.Router, context *Context)
• type Context
  • func (c *Context) Clone() *Context

Functions

func Register

func Register(rootRouter *mux.Router, context *Context)

Register registers the API endpoints on the given router.

Types

type Context

type Context struct {
	RequestID string
	Logger    logrus.FieldLogger
}

Context provides the API with all necessary data and interfaces for responding to requests.

It is cloned before each request, allowing per-request changes such as logger annotations.

func (*Context) Clone

func (c *Context) Clone() *Context

Clone creates a shallow copy of context, allowing clones to apply per-request changes.