deer

README

Deer

A go language http library using decorators.

Why Deer

Lightweight, lower dependence and efficient.

Quick Start

package main

import (
	"log"
	"net/http"

	"github.com/medivhyang/deer"
)

func main() {
	deer.Debug(true)

	r := deer.Default()

	r.Get("/", func(w deer.ResponseWriter, r *deer.Request) {
		w.Text(http.StatusOK, "hello world")
	})

	log.Fatalln(r.Run(":8080"))
}

More examples references /examples directory.

Documentation

Index

• Variables
• func Debug(b bool)
• func Output(writer io.Writer)
• func Params(r *http.Request) map[string]string
• type CORSOptions
• type EntryView
• type HandlerFunc
  • func (h HandlerFunc) Next(w ResponseWriter, r *Request)
  • func (h HandlerFunc) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Middleware
  • func AllowedMethods(methods ...string) Middleware
  • func BasicAuth(pairs map[string]string, realm ...string) Middleware
  • func BasicAuthWithFunc(f func(username, password string) bool, realm ...string) Middleware
  • func CORS(config ...CORSOptions) Middleware
  • func MaxAllowed(n int) Middleware
  • func Recovery(callback ...func(w ResponseWriter, r *Request, err interface{})) Middleware
  • func Timing(callback ...func(w ResponseWriter, r *Request, d time.Duration)) Middleware
  • func Trace(callback ...func(w ResponseWriter, r *Request)) Middleware
• type Request
  • func WrapRequest(r *http.Request) *Request
  • func (r *Request) AddCooke(cookie *http.Cookie)
  • func (r *Request) BasicAuth() (username string, password string, ok bool)
  • func (r *Request) BindForm(i interface{}) error
  • func (r *Request) BindJSON(i interface{}) error
  • func (r *Request) BindPostForm(i interface{}) error
  • func (r *Request) BindQuery(i interface{}) error
  • func (r *Request) BindXML(i interface{}) error
  • func (r *Request) Context() context.Context
  • func (r *Request) Cookie(key string) (string, error)
  • func (r *Request) CookieExists(key string) bool
  • func (r *Request) CookieOrDefault(key string, defaultValue ...string) string
  • func (r *Request) Form(key string) string
  • func (r *Request) FormExists(key string) bool
  • func (r *Request) Header(key string) string
  • func (r *Request) HeaderExists(key string) bool
  • func (r *Request) HeaderOrDefault(key string, value string) string
  • func (r *Request) Method() string
  • func (r *Request) Param(key string) string
  • func (r *Request) ParamExists(key string) bool
  • func (r *Request) ParamOrDefault(key string, value string) string
  • func (r *Request) Path() string
  • func (r *Request) PostForm(key string) string
  • func (r *Request) PostFormExists(key string) bool
  • func (r *Request) Query(key string) string
  • func (r *Request) QueryExists(key string) bool
  • func (r *Request) QueryOrDefault(key string, value string) string
  • func (r *Request) SetBasicAuth(username string, password string)
  • func (r *Request) SetContext(ctx context.Context)
  • func (r *Request) SetHeader(key string, value string)
• type Response
  • func WrapResponse(r *http.Response) *Response
  • func (r *Response) Bytes() ([]byte, error)
  • func (r *Response) Dump(body bool) ([]byte, error)
  • func (r *Response) JSON(value interface{}) error
  • func (r *Response) Pipe(writer io.Writer) error
  • func (r *Response) SaveFile(filename string) error
  • func (r *Response) Stream() (io.ReadCloser, error)
  • func (r *Response) Text() (string, error)
  • func (r *Response) XML(value interface{}) error
• type ResponseWriter
  • func WrapResponseWriter(w http.ResponseWriter) ResponseWriter
• type Router
  • func Default() *Router
  • func NewRouter() *Router
  • func (router *Router) Any(pattern string, handler HandlerFunc, middlewares ...Middleware) *Router
  • func (router *Router) Delete(pattern string, handler HandlerFunc, middlewares ...Middleware) *Router
  • func (router *Router) Get(pattern string, handler HandlerFunc, middlewares ...Middleware) *Router
  • func (router *Router) Group(prefix string, middlewares ...Middleware) *group
  • func (router *Router) Handle(method string, path string, handler HandlerFunc, middlewares ...Middleware) *Router
  • func (router *Router) HandleNotFound(h HandlerFunc) *Router
  • func (router *Router) Items() []EntryView
  • func (router *Router) Options(pattern string, handler HandlerFunc, middlewares ...Middleware) *Router
  • func (router *Router) Patch(pattern string, handler HandlerFunc, middlewares ...Middleware) *Router
  • func (router *Router) Post(pattern string, handler HandlerFunc, middlewares ...Middleware) *Router
  • func (router *Router) Prefix(p string) *Router
  • func (router *Router) Put(pattern string, handler HandlerFunc, middlewares ...Middleware) *Router
  • func (router *Router) Run(addr string) error
  • func (router *Router) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (router *Router) String() string
  • func (router *Router) Use(middlewares ...Middleware) *Router

Variables

var ErrResponseBodyHasRead = newError("http response", "body has read")

Functions

func Debug

func Debug(b bool)

func Output

func Output(writer io.Writer)

func Params

func Params(r *http.Request) map[string]string

Types

type CORSOptions

type CORSOptions struct {
	AllowOrigins     []string
	AllowMethods     []string
	AllowHeaders     []string
	ExposeHeaders    []string
	AllowCredentials bool
}

type EntryView

type EntryView struct {
	Method  string `json:"method"`
	Pattern string `json:"pattern"`
}

type HandlerFunc

type HandlerFunc func(w ResponseWriter, r *Request)

func (HandlerFunc) Next

func (h HandlerFunc) Next(w ResponseWriter, r *Request)

func (HandlerFunc) ServeHTTP

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

type Middleware

type Middleware = func(HandlerFunc) HandlerFunc

func AllowedMethods

func AllowedMethods(methods ...string) Middleware

func BasicAuth

func BasicAuth(pairs map[string]string, realm ...string) Middleware

func BasicAuthWithFunc

func BasicAuthWithFunc(f func(username, password string) bool, realm ...string) Middleware

func CORS

func CORS(config ...CORSOptions) Middleware

func MaxAllowed

func MaxAllowed(n int) Middleware

func Recovery

func Recovery(callback ...func(w ResponseWriter, r *Request, err interface{})) Middleware

func Timing

func Timing(callback ...func(w ResponseWriter, r *Request, d time.Duration)) Middleware

func Trace

func Trace(callback ...func(w ResponseWriter, r *Request)) Middleware

type Request

type Request struct {
	Raw *http.Request
	// contains filtered or unexported fields
}

func WrapRequest

func WrapRequest(r *http.Request) *Request

func (*Request) AddCooke

func (r *Request) AddCooke(cookie *http.Cookie)

func (*Request) BasicAuth

func (r *Request) BasicAuth() (username string, password string, ok bool)

func (*Request) BindForm

func (r *Request) BindForm(i interface{}) error

func (*Request) BindJSON

func (r *Request) BindJSON(i interface{}) error

func (*Request) BindPostForm

func (r *Request) BindPostForm(i interface{}) error

func (*Request) BindQuery

func (r *Request) BindQuery(i interface{}) error

func (*Request) BindXML

func (r *Request) BindXML(i interface{}) error

func (*Request) Context

func (r *Request) Context() context.Context

func (*Request) Cookie

func (r *Request) Cookie(key string) (string, error)

func (*Request) CookieExists

func (r *Request) CookieExists(key string) bool

func (*Request) CookieOrDefault

func (r *Request) CookieOrDefault(key string, defaultValue ...string) string

func (*Request) Form

func (r *Request) Form(key string) string

func (*Request) FormExists

func (r *Request) FormExists(key string) bool

func (*Request) Header

func (r *Request) Header(key string) string

func (*Request) HeaderExists

func (r *Request) HeaderExists(key string) bool

func (*Request) HeaderOrDefault

func (r *Request) HeaderOrDefault(key string, value string) string

func (*Request) Method

func (r *Request) Method() string

func (*Request) Param

func (r *Request) Param(key string) string

func (*Request) ParamExists

func (r *Request) ParamExists(key string) bool

func (*Request) ParamOrDefault

func (r *Request) ParamOrDefault(key string, value string) string

func (*Request) Path

func (r *Request) Path() string

func (*Request) PostForm

func (r *Request) PostForm(key string) string

func (*Request) PostFormExists

func (r *Request) PostFormExists(key string) bool

func (*Request) Query

func (r *Request) Query(key string) string

func (*Request) QueryExists

func (r *Request) QueryExists(key string) bool

func (*Request) QueryOrDefault

func (r *Request) QueryOrDefault(key string, value string) string

func (*Request) SetBasicAuth

func (r *Request) SetBasicAuth(username string, password string)

func (*Request) SetContext

func (r *Request) SetContext(ctx context.Context)

func (*Request) SetHeader

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

type Response

type Response struct {
	Raw *http.Response
	// contains filtered or unexported fields
}

func WrapResponse

func WrapResponse(r *http.Response) *Response

func (*Response) Bytes

func (r *Response) Bytes() ([]byte, error)

func (*Response) Dump

func (r *Response) Dump(body bool) ([]byte, error)

func (*Response) JSON

func (r *Response) JSON(value interface{}) error

func (*Response) Pipe

func (r *Response) Pipe(writer io.Writer) error

func (*Response) SaveFile

func (r *Response) SaveFile(filename string) error

func (*Response) Stream

func (r *Response) Stream() (io.ReadCloser, error)

func (*Response) Text

func (r *Response) Text() (string, error)

func (*Response) XML

func (r *Response) XML(value interface{}) error

type ResponseWriter

type ResponseWriter interface {
	Raw() http.ResponseWriter
	StatusCode(statusCode int)
	Header(key string, value string) ResponseWriter
	Text(statusCode int, text string)
	HTML(statusCode int, content string)
	JSON(statusCode int, value interface{})
	XML(statusCode int, value interface{})
}

func WrapResponseWriter

func WrapResponseWriter(w http.ResponseWriter) ResponseWriter

type Router

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

func Default

func Default() *Router

func NewRouter

func NewRouter() *Router

func (*Router) Any

func (router *Router) Any(pattern string, handler HandlerFunc, middlewares ...Middleware) *Router

func (*Router) Delete

func (router *Router) Delete(pattern string, handler HandlerFunc, middlewares ...Middleware) *Router

func (*Router) Get

func (router *Router) Get(pattern string, handler HandlerFunc, middlewares ...Middleware) *Router

func (*Router) Group

func (router *Router) Group(prefix string, middlewares ...Middleware) *group

func (*Router) Handle

func (router *Router) Handle(method string, path string, handler HandlerFunc, middlewares ...Middleware) *Router

func (*Router) HandleNotFound

func (router *Router) HandleNotFound(h HandlerFunc) *Router

func (*Router) Items

func (router *Router) Items() []EntryView

func (*Router) Options

func (router *Router) Options(pattern string, handler HandlerFunc, middlewares ...Middleware) *Router

func (*Router) Patch

func (router *Router) Patch(pattern string, handler HandlerFunc, middlewares ...Middleware) *Router

func (*Router) Post

func (router *Router) Post(pattern string, handler HandlerFunc, middlewares ...Middleware) *Router

func (*Router) Prefix

func (router *Router) Prefix(p string) *Router

func (*Router) Put

func (router *Router) Put(pattern string, handler HandlerFunc, middlewares ...Middleware) *Router

func (*Router) Run

func (router *Router) Run(addr string) error

func (*Router) ServeHTTP

func (router *Router) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*Router) String

func (router *Router) String() string

func (*Router) Use

func (router *Router) Use(middlewares ...Middleware) *Router