yoda

README

yoda

Documentation

Index

• func NewServer(config Config) *yoda
• func NewServerWithConfig(config atreugo.Config) *yoda
• type Config
• type Context
  • func (c *Context) Bind(i interface{}) error
  • func (c *Context) Created(obj interface{}) error
  • func (c *Context) Error(err vader.Error) error
  • func (c *Context) FromContext(key string) interface{}
  • func (c *Context) GetHeader(key string) []byte
  • func (c *Context) JSON(status int, obj interface{}) error
  • func (c *Context) NewResponse(status int, message string) error
  • func (c *Context) Next() error
  • func (c *Context) OK(obj interface{}) error
• type Handler
• type Response
• type Router
  • func (r *Router) Delete(path string, handler Handler)
  • func (r *Router) Get(path string, handler Handler)
  • func (r *Router) Patch(path string, handler Handler)
  • func (r *Router) Post(path string, handler Handler)
  • func (r *Router) Put(path string, handler Handler)
  • func (r *Router) Use(middlewares ...Handler)
• type Yoda

Functions

func NewServer

func NewServer(config Config) *yoda

Creates a new standard yoda server

func NewServerWithConfig

func NewServerWithConfig(config atreugo.Config) *yoda

Creates a yoda server with config

Types

type Config

type Config struct {
	Addr         string
	Name         string
	CORS         cors.Config
	IdleTimeout  time.Duration
	WriteTimeout time.Duration
	ReadTimeout  time.Duration
}

Config

type Context

type Context struct {
	Parent *atreugo.RequestCtx
}

Context struct

func (*Context) Bind

func (c *Context) Bind(i interface{}) error

Binds a json into a struct

func (*Context) Created

func (c *Context) Created(obj interface{}) error

Creates a JSON response with status created

func (*Context) Error

func (c *Context) Error(err vader.Error) error

Creates a JSON response with an error

func (*Context) FromContext

func (c *Context) FromContext(key string) interface{}

Returns a value from a context using the key

func (*Context) GetHeader

func (c *Context) GetHeader(key string) []byte

func (*Context) JSON

func (c *Context) JSON(status int, obj interface{}) error

Creates a JSON response

func (*Context) NewResponse

func (c *Context) NewResponse(status int, message string) error

Creates a default response with a message

func (*Context) Next

func (c *Context) Next() error

Next function

func (*Context) OK

func (c *Context) OK(obj interface{}) error

Creates a JSON response with status OK

type Handler

type Handler func(*Context) error

Handler

type Response

type Response struct {
	Message string `json:"message,omitempty"`
	Error   string `json:"error,omitempty"`
}

Response struct

type Router

type Router struct {
	Parent *atreugo.Router
}

Router struct

func (*Router) Delete

func (r *Router) Delete(path string, handler Handler)

func (*Router) Get

func (r *Router) Get(path string, handler Handler)

func (*Router) Patch

func (r *Router) Patch(path string, handler Handler)

func (*Router) Post

func (r *Router) Post(path string, handler Handler)

func (*Router) Put

func (r *Router) Put(path string, handler Handler)

func (*Router) Use

func (r *Router) Use(middlewares ...Handler)

Append middlewares to router

type Yoda

type Yoda interface {
	Run()
}

Server interface