api

package

v1.0.0-rc.1 Latest Latest Go to latest Published: Jul 6, 2020 License: MIT Imports: 7 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

Package api implements the REST API interface.

This section is empty.

This section is empty.

This section is empty.

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

API represents an API instance.

func New(o NewOptions) (*API, error)

New creates a new API instance by the given options.

func (api *API) Listen() error

Listen starts listening for HTTP requests.

type NewOptions struct {
	Address string
	DB      *sql.DB
	AppEnv  string
}

NewOptions represents the options which can be set when creating a new API instance.

Path	Synopsis
locations Package locations implements the REST API locations endpoint.	Package locations implements the REST API locations endpoint.
request Package request provides interface for handling REST API requests.	Package request provides interface for handling REST API requests.