xrest

README

xrest

JSON Restful API with context.Context in mind.

Plug structure

TODO

• add realtime plug (like phoenix channel)
• add docs
• add a project site (github pages)
• add a guide
• add session plug
• add more...

Documentation

Index

• type Handler
• type HandlerFunc
  • func (h HandlerFunc) Plug(_ Handler) Handler
  • func (h HandlerFunc) ServeHTTP(ctx context.Context, w http.ResponseWriter, r *http.Request)
• type Pipeline
  • func NewPipeline() *Pipeline
  • func (p *Pipeline) HTTPHandler() http.Handler
  • func (p *Pipeline) Handler() Handler
  • func (p *Pipeline) Plug(plugs ...Plugger) *Pipeline
  • func (p *Pipeline) Plugs() []Plugger
  • func (p *Pipeline) SetHandler(h Handler) *Pipeline
• type Plugger

Types

type Handler

type Handler interface {
	ServeHTTP(context.Context, http.ResponseWriter, *http.Request)
}

type HandlerFunc

type HandlerFunc func(context.Context, http.ResponseWriter, *http.Request)

func (HandlerFunc) Plug

func (h HandlerFunc) Plug(_ Handler) Handler

func (HandlerFunc) ServeHTTP

func (h HandlerFunc) ServeHTTP(ctx context.Context, w http.ResponseWriter, r *http.Request)

type Pipeline

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

func NewPipeline

func NewPipeline() *Pipeline

func (*Pipeline) HTTPHandler

func (p *Pipeline) HTTPHandler() http.Handler

func (*Pipeline) Handler

func (p *Pipeline) Handler() Handler

func (*Pipeline) Plug

func (p *Pipeline) Plug(plugs ...Plugger) *Pipeline

func (*Pipeline) Plugs

func (p *Pipeline) Plugs() []Plugger

func (*Pipeline) SetHandler

func (p *Pipeline) SetHandler(h Handler) *Pipeline

type Plugger

type Plugger interface {
	Plug(Handler) Handler
}