api

Documentation

Index

• Variables
• func AddFilter(f Filter)
• func AddFilterExecutor(fe FilterExecutor)
• func AddService(s Service)
• func Init(service web.Service, z Initializer) error
• type Dispatcher
  • func NewDispatcher() *Dispatcher
  • func (d *Dispatcher) AddError(e *eerr.Error)
  • func (d *Dispatcher) AddResult(key, value string)
  • func (d *Dispatcher) Dispatch(e *event.Event)
  • func (d *Dispatcher) Error(index int) *eerr.Error
  • func (d *Dispatcher) HasError() bool
  • func (d *Dispatcher) Result(key string) string
  • func (d *Dispatcher) Results() map[string]string
• type Filter
• type FilterExecutor
• type Initializer
• type Route
• type RouteHandler
• type Service

Variables

var (
	// MethodGet GET
	MethodGet = "GET"

	// MethodPost POST
	MethodPost = "POST"

	// MethodPut PUT
	MethodPut = "PUT"

	// MethodPatch PATCH
	MethodPatch = "PATCH"

	// MethodDelete DELETE
	MethodDelete = "DELETE"

	// MethodHead HEAD
	MethodHead = "HEAD"

	// MethodOptions OPTIONS
	MethodOptions = "OPTIONS"
)

var (

	// ErrBadName bad API service name
	ErrBadName = errors.New("Bad API service name")
)

Functions

func AddFilter

func AddFilter(f Filter)

AddFilter add filter

func AddFilterExecutor

func AddFilterExecutor(fe FilterExecutor)

AddFilterExecutor add filter executor directly

func AddService

func AddService(s Service)

AddService add service to API

func Init

func Init(service web.Service, z Initializer) error

Init API server

Types

type Dispatcher

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

Dispatcher for API

func NewDispatcher

func NewDispatcher() *Dispatcher

NewDispatcher create new dispatcher

func (*Dispatcher) AddError

func (d *Dispatcher) AddError(e *eerr.Error)

AddError add error

func (*Dispatcher) AddResult

func (d *Dispatcher) AddResult(key, value string)

AddResult add result

func (*Dispatcher) Dispatch

func (d *Dispatcher) Dispatch(e *event.Event)

Dispatch event

func (*Dispatcher) Error

func (d *Dispatcher) Error(index int) *eerr.Error

Error get single error by index

func (*Dispatcher) HasError

func (d *Dispatcher) HasError() bool

HasError check if got an error

func (*Dispatcher) Result

func (d *Dispatcher) Result(key string) string

Result get result with key

func (*Dispatcher) Results

func (d *Dispatcher) Results() map[string]string

Results get all results

type Filter

type Filter interface {
	// Execute do filtering
	Execute(req *restful.Request) *eerr.Error
}

Filter API request filter

type FilterExecutor

type FilterExecutor func(req *restful.Request) *eerr.Error

FilterExecutor filter handler function

type Initializer

type Initializer interface {
	// InitFilters set go-restful filters
	InitFilters()

	// InitServices set services
	InitServices()
}

Initializer of API server

type Route

type Route struct {
	Method  string
	Path    string
	Input   interface{}
	Handler RouteHandler
}

Route config element

type RouteHandler

type RouteHandler func(ctx *engine.Context, input interface{}) (interface{}, *eerr.Error)

RouteHandler route handler function

type Service

type Service interface {
	Name() string
	Routes() []*Route
}

Service API service