mini

README

mini

Mini Golang Web framework (Alpha stage)

Documentation

Index

• type Context
  • func (c *Context) BadRequest(data interface{}, token string)
  • func (c *Context) BindJson(obj interface{}) error
  • func (c *Context) CreatedResponse(data interface{}, token string)
  • func (c *Context) Get(key string) (value any, exists bool)
  • func (c *Context) InternalServerError(data interface{}, token string)
  • func (c *Context) MovedPermenantly(location, token string)
  • func (c *Context) NotFound(data interface{}, token string)
  • func (c *Context) OkResponse(data interface{}, token string)
  • func (c *Context) ParseMultiParForm() error
  • func (c *Context) Set(key string, value any)
  • func (c *Context) ShouldGet(key string) any
  • func (c *Context) UnAuthorized(data interface{}, token string)
• type CorsConfig
• type HandlerFunc
  • func (handler *HandlerFunc) Name(i interface{}) string
• type MiddlewareFunc
• type Mini
  • func NewMini() *Mini
  • func (mini *Mini) CONNECT(route string, handler HandlerFunc, middleware ...MiddlewareFunc)
  • func (mini *Mini) DELETE(route string, handler HandlerFunc, middleware ...MiddlewareFunc)
  • func (mini *Mini) GET(route string, handler HandlerFunc, middleware ...MiddlewareFunc)
  • func (mini *Mini) Group(prefix string) *RouterGroup
  • func (mini *Mini) OPTIONS(route string, handler HandlerFunc, middleware ...MiddlewareFunc)
  • func (mini *Mini) PATCH(route string, handler HandlerFunc, middleware ...MiddlewareFunc)
  • func (mini *Mini) POST(route string, handler HandlerFunc, middleware ...MiddlewareFunc)
  • func (mini *Mini) PUT(route string, handler HandlerFunc, middleware ...MiddlewareFunc)
  • func (mini *Mini) Run(addr string) error
  • func (mini *Mini) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (mini *Mini) SetCorsConfig(config *CorsConfig)
  • func (mini *Mini) TRACE(route string, handler HandlerFunc, middleware ...MiddlewareFunc)
  • func (mini *Mini) Use(middleware ...MiddlewareFunc)
• type NameRoutes
• type Request
  • func (request *Request) GetHeader(key string) string
• type Response
  • func (r *Response) JSON(data interface{}) (*Response, error)
  • func (r *Response) SetHeader(key, value string)
  • func (r *Response) StatusCode(code int)
• type Route
• type RouterGroup
  • func (rg *RouterGroup) CONNECT(route string, handler HandlerFunc, middleware ...MiddlewareFunc)
  • func (rg *RouterGroup) DELETE(route string, handler HandlerFunc, middleware ...MiddlewareFunc)
  • func (rg *RouterGroup) GET(route string, handler HandlerFunc, middleware ...MiddlewareFunc)
  • func (group *RouterGroup) Group(prefix string) *RouterGroup
  • func (rg *RouterGroup) HEAD(route string, handler HandlerFunc, middleware ...MiddlewareFunc)
  • func (rg *RouterGroup) OPTIONS(route string, handler HandlerFunc, middleware ...MiddlewareFunc)
  • func (rg *RouterGroup) PATCH(route string, handler HandlerFunc, middleware ...MiddlewareFunc)
  • func (rg *RouterGroup) POST(route string, handler HandlerFunc, middleware ...MiddlewareFunc)
  • func (rg *RouterGroup) PUT(route string, handler HandlerFunc, middleware ...MiddlewareFunc)
  • func (rg *RouterGroup) TRACE(route string, handler HandlerFunc, middleware ...MiddlewareFunc)
  • func (g *RouterGroup) Use(middleware ...MiddlewareFunc)

Types

type Context

type Context struct {
	Request  *Request
	Response *Response
	Keys     map[string]any
	// contains filtered or unexported fields
}

func (*Context) BadRequest

func (c *Context) BadRequest(data interface{}, token string)

func (*Context) BindJson

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

func (*Context) CreatedResponse

func (c *Context) CreatedResponse(data interface{}, token string)

func (*Context) Get

func (c *Context) Get(key string) (value any, exists bool)

func (*Context) InternalServerError

func (c *Context) InternalServerError(data interface{}, token string)

func (*Context) MovedPermenantly

func (c *Context) MovedPermenantly(location, token string)

func (*Context) NotFound

func (c *Context) NotFound(data interface{}, token string)

func (*Context) OkResponse

func (c *Context) OkResponse(data interface{}, token string)

func (*Context) ParseMultiParForm

func (c *Context) ParseMultiParForm() error

func (*Context) Set

func (c *Context) Set(key string, value any)

func (*Context) ShouldGet

func (c *Context) ShouldGet(key string) any

func (*Context) UnAuthorized

func (c *Context) UnAuthorized(data interface{}, token string)

type CorsConfig

type CorsConfig struct {
	AllowedOrigins []string
	AllowedHeaders []string
	AllowedMethods []string
}

type HandlerFunc

type HandlerFunc func(*Context) error

func (*HandlerFunc) Name

func (handler *HandlerFunc) Name(i interface{}) string

type MiddlewareFunc

type MiddlewareFunc func(HandlerFunc) HandlerFunc

type Mini

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

func NewMini

func NewMini() *Mini

func (*Mini) CONNECT

func (mini *Mini) CONNECT(route string, handler HandlerFunc, middleware ...MiddlewareFunc)

func (*Mini) DELETE

func (mini *Mini) DELETE(route string, handler HandlerFunc, middleware ...MiddlewareFunc)

func (*Mini) GET

func (mini *Mini) GET(route string, handler HandlerFunc, middleware ...MiddlewareFunc)

func (*Mini) Group

func (mini *Mini) Group(prefix string) *RouterGroup

func (*Mini) OPTIONS

func (mini *Mini) OPTIONS(route string, handler HandlerFunc, middleware ...MiddlewareFunc)

func (*Mini) PATCH

func (mini *Mini) PATCH(route string, handler HandlerFunc, middleware ...MiddlewareFunc)

func (*Mini) POST

func (mini *Mini) POST(route string, handler HandlerFunc, middleware ...MiddlewareFunc)

func (*Mini) PUT

func (mini *Mini) PUT(route string, handler HandlerFunc, middleware ...MiddlewareFunc)

func (*Mini) Run

func (mini *Mini) Run(addr string) error

func (*Mini) ServeHTTP

func (mini *Mini) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*Mini) SetCorsConfig

func (mini *Mini) SetCorsConfig(config *CorsConfig)

func (*Mini) TRACE

func (mini *Mini) TRACE(route string, handler HandlerFunc, middleware ...MiddlewareFunc)

func (*Mini) Use

func (mini *Mini) Use(middleware ...MiddlewareFunc)

type NameRoutes

type NameRoutes struct {
	RouteName string
	// contains filtered or unexported fields
}

type Request

type Request struct {
	*http.Request
}

func (*Request) GetHeader

func (request *Request) GetHeader(key string) string

type Response

type Response struct {
	http.ResponseWriter
	Status int
}

func (*Response) JSON

func (r *Response) JSON(data interface{}) (*Response, error)

func (*Response) SetHeader

func (r *Response) SetHeader(key, value string)

func (*Response) StatusCode

func (r *Response) StatusCode(code int)

type Route

type Route struct {
	Path   string
	Method string
	// contains filtered or unexported fields
}

type RouterGroup

type RouterGroup struct {
	Mini *Mini
	// contains filtered or unexported fields
}

func (*RouterGroup) CONNECT

func (rg *RouterGroup) CONNECT(route string, handler HandlerFunc, middleware ...MiddlewareFunc)

func (*RouterGroup) DELETE

func (rg *RouterGroup) DELETE(route string, handler HandlerFunc, middleware ...MiddlewareFunc)

func (*RouterGroup) GET

func (rg *RouterGroup) GET(route string, handler HandlerFunc, middleware ...MiddlewareFunc)

func (*RouterGroup) Group

func (group *RouterGroup) Group(prefix string) *RouterGroup

func (*RouterGroup) HEAD

func (rg *RouterGroup) HEAD(route string, handler HandlerFunc, middleware ...MiddlewareFunc)

func (*RouterGroup) OPTIONS

func (rg *RouterGroup) OPTIONS(route string, handler HandlerFunc, middleware ...MiddlewareFunc)

func (*RouterGroup) PATCH

func (rg *RouterGroup) PATCH(route string, handler HandlerFunc, middleware ...MiddlewareFunc)

func (*RouterGroup) POST

func (rg *RouterGroup) POST(route string, handler HandlerFunc, middleware ...MiddlewareFunc)

func (*RouterGroup) PUT

func (rg *RouterGroup) PUT(route string, handler HandlerFunc, middleware ...MiddlewareFunc)

func (*RouterGroup) TRACE

func (rg *RouterGroup) TRACE(route string, handler HandlerFunc, middleware ...MiddlewareFunc)

func (*RouterGroup) Use

func (g *RouterGroup) Use(middleware ...MiddlewareFunc)