restapi

Documentation

Index

• type RESTError
• type RESTServer
  • func NewRestServer(errChan chan error, l golog.Logger, config config.Store) *RESTServer
  • func (rs *RESTServer) Router() *httprouter.Router
  • func (rs *RESTServer) SaveFiles(r *http.Request, ps httprouter.Params) *RouteReply
  • func (rs *RESTServer) Status(r *http.Request, ps httprouter.Params) *RouteReply
  • func (rs *RESTServer) Stop() error
• type RouteHandler
• type RouteReply

Types

type RESTError

type RESTError struct {
	Message     string `json:"message"`
	Description string `json:"description,omitempty"`
	Details     string `json:"details"`
}

RESTError is the standard structure for rest api errors

type RESTServer

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

func NewRestServer

func NewRestServer(errChan chan error, l golog.Logger, config config.Store) *RESTServer

func (*RESTServer) Router

func (rs *RESTServer) Router() *httprouter.Router

func (*RESTServer) SaveFiles

func (rs *RESTServer) SaveFiles(r *http.Request, ps httprouter.Params) *RouteReply

func (*RESTServer) Status

func (rs *RESTServer) Status(r *http.Request, ps httprouter.Params) *RouteReply

func (*RESTServer) Stop

func (rs *RESTServer) Stop() error

type RouteHandler

type RouteHandler func(*http.Request, httprouter.Params) *RouteReply

type RouteReply

type RouteReply struct {
	Code  int
	Error *RESTError
	Data  interface{}
}