boltimore

README

Boltimore

Super-lightweight framework for rapid development of RESTful APIs based on bolted.

Documentation

Index

• type Boltimore
  • func NewWithExistingDBAndWatcher(db *bolted.Bolted, w *watcher.Watcher, options ...Option) (*Boltimore, error)
  • func Open(dir string, options ...Option) (*Boltimore, error)
  • func (b *Boltimore) Close() error
• type ChangeWatcherContext
• type CronFunctionContext
• type InitFunctionContext
• type Option
  • func ChangeWatcher(path string, fn func(cwc *ChangeWatcherContext)) Option
  • func CronFunction(schedule string, fn func(cfc *CronFunctionContext)) Option
  • func Endpoint(method, path string, fn func(rc *RequestContext) error) Option
  • func InitFunction(fn func(ifc *InitFunctionContext) error) Option
  • func ZapLogger(l *zap.SugaredLogger) Option
• type RequestContext
  • func (r *RequestContext) ParseJSON(v interface{}) error
  • func (r *RequestContext) RespondWithError(error string, statusCode int) error
  • func (r *RequestContext) RespondWithJSON(v interface{}) error
  • func (r *RequestContext) RespondWithStatusCode(statusCode int) error
  • func (r *RequestContext) RespondWithStatusCodeAndJSON(statusCode int, v interface{}) error
  • func (r *RequestContext) RouteVariable(name string) string

Types

type Boltimore

type Boltimore struct {
	*mux.Router
	DB *bolted.Bolted

	Watcher *watcher.Watcher
	// contains filtered or unexported fields
}

func NewWithExistingDBAndWatcher

func NewWithExistingDBAndWatcher(db *bolted.Bolted, w *watcher.Watcher, options ...Option) (*Boltimore, error)

func Open

func Open(dir string, options ...Option) (*Boltimore, error)

func (*Boltimore) Close

func (b *Boltimore) Close() error

type ChangeWatcherContext

type ChangeWatcherContext struct {
	DB     *bolted.Bolted
	Logger *zap.SugaredLogger
}

type CronFunctionContext

type CronFunctionContext struct {
	DB     *bolted.Bolted
	Logger *zap.SugaredLogger
}

type InitFunctionContext

type InitFunctionContext struct {
	DB     *bolted.Bolted
	Logger *zap.SugaredLogger
}

type Option

type Option func(b *Boltimore) error

func ChangeWatcher

func ChangeWatcher(path string, fn func(cwc *ChangeWatcherContext)) Option

func CronFunction

func CronFunction(schedule string, fn func(cfc *CronFunctionContext)) Option

func Endpoint

func Endpoint(method, path string, fn func(rc *RequestContext) error) Option

func InitFunction

func InitFunction(fn func(ifc *InitFunctionContext) error) Option

func ZapLogger

func ZapLogger(l *zap.SugaredLogger) Option

type RequestContext

type RequestContext struct {
	Request        *http.Request
	ResponseWriter http.ResponseWriter
	DB             *bolted.Bolted

	Watcher *watcher.Watcher
	Logger  *zap.SugaredLogger
	// contains filtered or unexported fields
}

func (*RequestContext) ParseJSON

func (r *RequestContext) ParseJSON(v interface{}) error

func (*RequestContext) RespondWithError

func (r *RequestContext) RespondWithError(error string, statusCode int) error

func (*RequestContext) RespondWithJSON

func (r *RequestContext) RespondWithJSON(v interface{}) error

func (*RequestContext) RespondWithStatusCode

func (r *RequestContext) RespondWithStatusCode(statusCode int) error

func (*RequestContext) RespondWithStatusCodeAndJSON

func (r *RequestContext) RespondWithStatusCodeAndJSON(statusCode int, v interface{}) error

func (*RequestContext) RouteVariable

func (r *RequestContext) RouteVariable(name string) string