api

Documentation

Index

• func Register(public *mux.Router, context *Context)
• type ApiTestHelper
  • func SetupApiTestHelper(t *testing.T) *ApiTestHelper
  • func (th *ApiTestHelper) TearDown(t *testing.T)
• type Context
  • func (c *Context) Clone() *Context

Functions

func Register

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

Register registers the API endpoints on the given router.

Types

type ApiTestHelper

type ApiTestHelper struct {
	App      *app.App
	Router   *mux.Router
	Server   *httptest.Server
	SqlStore *store.SqlStore
}

func SetupApiTestHelper

func SetupApiTestHelper(t *testing.T) *ApiTestHelper

func (*ApiTestHelper) TearDown

func (th *ApiTestHelper) TearDown(t *testing.T)

type Context

type Context struct {
	RequestID string
	Logger    logrus.FieldLogger
	App       *app.App
	Session   *model.Session
}

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

func (*Context) Clone

func (c *Context) Clone() *Context

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