restserver

package

v1.0.0 Latest Latest Go to latest Published: Oct 12, 2021 License: BSD-3-Clause Imports: 13 Imported by: 0

Details

Package restserver implements a pluggable library for REST servers.

This section is empty.

This section is empty.

This section is empty.

type Config struct {
	InsecureServing InsecureServingConfig
	Mode            string
	Middlewares     []string
	UseHealthz      bool
}

Config holds configs for REST server.

type InsecureServingConfig struct {
	Host string
	Port int
}

InsecureServingConfig holds insecure serving configs for REST server.

func (c *InsecureServingConfig) Addr() string

Addr returns the full address(host:port).

type RESTServer interface {
	Start() error
	Stop() error
}

RESTServer defines the interface of a REST server.

func New(cfg *Config, serviceRouter service.Router) RESTServer

New returns the concrete value of interface RESTServer.

Path	Synopsis
controller
v1/timer Package timer provides an interface of HTTP controller for RESTful resource Timer as well as an implementation.	Package timer provides an interface of HTTP controller for RESTful resource Timer as well as an implementation.
middleware Package middleware provides middlewares for REST server.	Package middleware provides middlewares for REST server.
response Package response provides a uniformed interface for writing HTTP responses.	Package response provides a uniformed interface for writing HTTP responses.