api

package

v0.0.0-...-50815b3 Latest Latest Go to latest Published: Apr 24, 2019 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

This section is empty.

This section is empty.

This section is empty.

type API struct {
	// contains filtered or unexported fields
}

API defines the API server. It is primarily a REST interface through which service.Service can be accessed.

func New(logger *zap.SugaredLogger, opts CoreOpts) (*API, error)

New creates a new API server - start it using Run(). Returns a callback to close connection

func (a *API) Run(host, port string, opts RunOpts) error

Run spins up the API server

func (a *API) Stop()

Stop releases resources and shuts down the API server

type CoreOpts struct {
	Host     string
	Port     string
	CertFile string
	Token    string
}

CoreOpts defines options for connecting to pinpoint-core

type RunOpts struct {
	CertFile string
	KeyFile  string
	Token    string
}

RunOpts defines options for API server startup