api

Documentation

Index

• Variables
• func GetAPIIdentifier(ctx context.Context) string
• func ServeJSONError(logger *zap.Logger, w http.ResponseWriter, status int, err error)
• func SetAPIIdentifier(ctx context.Context, identity string) context.Context
• type Config
• type Server
  • func NewServer(log *zap.Logger, listener net.Listener, apiKeys map[string]string) *Server
  • func (server *Server) Close() error
  • func (server *Server) LogRoutes() error
  • func (server *Server) NewAPI(path string, register func(*mux.Router))
  • func (server *Server) Run(ctx context.Context) (err error)

Variables

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

Error is an error class for API http server error.

Functions

func GetAPIIdentifier

func GetAPIIdentifier(ctx context.Context) string

GetAPIIdentifier return the authenticated identity of the client.

func ServeJSONError

func ServeJSONError(logger *zap.Logger, w http.ResponseWriter, status int, err error)

ServeJSONError writes JSON error to response output stream.

func SetAPIIdentifier

func SetAPIIdentifier(ctx context.Context, identity string) context.Context

SetAPIIdentifier sets the satellite identifier to the context.

Types

type Config

type Config struct {
	Address string   `help:"public address to listen on" default:":10000"`
	Keys    []string `help:"List of user:secret pairs to connect to service endpoints."`
}

Config holds API endpoint configuration.

type Server

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

Server represents storjscan API web server.

architecture: Endpoint

func NewServer

func NewServer(log *zap.Logger, listener net.Listener, apiKeys map[string]string) *Server

NewServer creates new API server instance.

func (*Server) Close

func (server *Server) Close() error

Close closes server and underlying listener.

func (*Server) LogRoutes

func (server *Server) LogRoutes() error

LogRoutes print out registered routes to the log.

func (*Server) NewAPI

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

NewAPI creates new API route and register endpoint methods.

func (*Server) Run

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

Run runs the server that host api endpoints.