yoda

README

Yoda web framework

built on top of atreugo.

Example server on localhost:8080:

srv := yoda.NewServer(yoda.Config{
	Addr:   ":8080",
	Name:   "server",
})

group := srv.Group("/group")

group.Get("/create", func (ctx *yoda.Context) error {
    return ctx.JSON(200, "")
})

srv.StartServer()

Documentation

Index

• type Config
• type Context
  • func (c *Context) AttachContext(context context.Context)
  • func (c *Context) AttachedContext() context.Context
  • func (c *Context) Bind(i interface{}) vader.Error
  • func (c *Context) BindWithValidator(i interface{}, key string, fn validator.Func) vader.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) GetValue(key string) interface{}
  • func (c *Context) JSON(status int, obj interface{}) error
  • func (c *Context) Message(status int, message string) error
  • func (c *Context) Next() error
  • func (c *Context) Param(key string) interface{}
  • func (c *Context) Query(key string) []byte
  • func (c *Context) SetValue(key string, value interface{})
• type Handler
• type Response
• type Router
  • func (r *Router) Delete(path string, handler Handler, middlewares ...Handler)
  • func (r *Router) Get(path string, handler Handler, middlewares ...Handler)
  • func (r *Router) Patch(path string, handler Handler, middlewares ...Handler)
  • func (r *Router) Post(path string, handler Handler, middlewares ...Handler)
  • func (r *Router) Put(path string, handler Handler, middlewares ...Handler)
  • func (r *Router) Use(middlewares ...Handler)
• type Yoda
  • func NewServer(config Config) *Yoda
  • func NewServerWithConfig(config atreugo.Config) *Yoda
  • func (y *Yoda) Group(path string, fns ...Handler) *Router
  • func (y *Yoda) Start() error

Types

type Config

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

Config struct

type Context

type Context struct {
	Parent *atreugo.RequestCtx
}

Context struct

func (*Context) AttachContext

func (c *Context) AttachContext(context context.Context)

AttachContext adds a new context to the current one

func (*Context) AttachedContext

func (c *Context) AttachedContext() context.Context

AttachedContext returns the attached context

func (*Context) Bind

func (c *Context) Bind(i interface{}) vader.Error

Bind binds a json into a struct

func (*Context) BindWithValidator

func (c *Context) BindWithValidator(i interface{}, key string, fn validator.Func) vader.Error

BindWithValidator binds a json with custom validaroe

func (*Context) Error

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

Error creates a JSON response with an error

func (*Context) FromContext

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

FromContext returns a value from a context using the key

func (*Context) GetHeader

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

GetHeader returns an specific value of a given key

func (*Context) GetValue

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

GetValue gets the value set by SetValue

func (*Context) JSON

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

JSON creates a JSON response

func (*Context) Message

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

Message creates a default response with a message

func (*Context) Next

func (c *Context) Next() error

Next function

func (*Context) Param

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

Param returns the value of a given param

func (*Context) Query

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

Query returns the value of a given query key

func (*Context) SetValue

func (c *Context) SetValue(key string, value interface{})

SetValue sets a value with a given key

type Handler

type Handler func(*Context) error

Handler struct

type Response

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

Response struct

type Router

type Router struct {
	Parent *atreugo.Router
}

Router struct

func (*Router) Delete

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

Delete creates a listener of DELETE requests

func (*Router) Get

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

Get creates a listener of GET requests

func (*Router) Patch

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

PATCH creates a listener of PATCH requests

func (*Router) Post

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

Post creates a listener of POST requests

func (*Router) Put

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

Put creates a listener of PUT requests

func (*Router) Use

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

Use appends middlewares to router

type Yoda

type Yoda struct {
	*atreugo.Atreugo
	// contains filtered or unexported fields
}

Server struct

func NewServer

func NewServer(config Config) *Yoda

NewServer creates a new standard yoda server

func NewServerWithConfig

func NewServerWithConfig(config atreugo.Config) *Yoda

NewServerWithConfig creates a yoda server with config

func (*Yoda) Group

func (y *Yoda) Group(path string, fns ...Handler) *Router

Group creates a group

func (*Yoda) Start

func (y *Yoda) Start() error

Start starts the yoda server