server

package

v0.0.0-...-61a96ab Latest Latest Go to latest Published: Sep 18, 2019 License: Apache-2.0 Imports: 9 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

View Source

const (
	// APICommonPrefix is a restful API prefix.
	APICommonPrefix = "/api"
)

View Source

const (
	// APIPrefix is a base path to restful APIs.
	APIPrefix = APICommonPrefix + "/v1"
)

This section is empty.

This section is empty.

type Option func(*Router) error

Option stands for functional parameter

func WithController(wc *controller.Controller) Option

WithController is an functional parameter to use a controller.

func WithGithubWebhook(secret string) Option

WithGithubWebhook is a functional parameter to use a github webhook secret.

func WithVersion(version interface{}) Option

WithVersion sets the version object. This will be used for health endpoint.

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

Router is an abstraction over mux.Router

func New(cfg *config.Config, opts ...Option) (*Router, error)

New creates a new instance of a Rounter

func (r *Router) Start() error

Start a new HTTP server