api

package

v0.0.0-...-8495d1f Latest Latest Go to latest Published: Nov 11, 2021 License: Apache-2.0 Imports: 21 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

This section is empty.

This section is empty.

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

Register registers the API endpoints on the given router.

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

func SetupApiTestHelper(t *testing.T) *ApiTestHelper

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

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 (c *Context) Clone() *Context

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