api

package

v0.0.0-...-a092f05 Latest Latest Go to latest Published: Mar 18, 2022 License: AGPL-3.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

This section is empty.

View Source

var Error = errs.Class("api server")

Error is an error class for API http server error.

This section is empty.

type Config struct {
	Address string
}

Config holds API endpoint configuration.

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

Server represents storjscan API web server.

architecture: Endpoint

func NewServer(log *zap.Logger, listener net.Listener) *Server

NewServer creates new API server instance.

func (server *Server) Close() error

Close closes server and underlying listener.

func (server *Server) NewAPI(path string, register func(*mux.Router))

NewAPI creates new API route and register endpoint methods.

func (server *Server) Register(register func(*mux.Router))

func (server *Server) Run(ctx context.Context) (err error)

Run runs the server that host api endpoints.