gen

README

gen

A demo web framework for golang

Documentation

Index

• Constants
• type Accounts
• type Context
  • func (c *Context) Abort()
  • func (c *Context) AbortWithStatus(code int)
  • func (c *Context) Cookie(name string) (string, error)
  • func (c *Context) Copy() *Context
  • func (c *Context) Data(code int, contentType string, data []byte)
  • func (c *Context) File(filePath string)
  • func (c *Context) Get(key string) (value any, ok bool)
  • func (c *Context) HTML(code int, name string, data any)
  • func (c *Context) HandlerName() string
  • func (c *Context) JSON(code int, obj any)
  • func (c *Context) MustGet(key string) any
  • func (c *Context) Next()
  • func (c *Context) Param(key string) string
  • func (c *Context) PostForm(key string) string
  • func (c *Context) Query(key string) string
  • func (c *Context) Redirect(location string)
  • func (c *Context) RemoteIP() string
  • func (c *Context) Set(key string, value any)
  • func (c *Context) SetCookie(name string, value string, maxAge int, path string, domain string, secure bool, ...)
  • func (c *Context) SetHeader(key, value string)
  • func (c *Context) Status(code int)
  • func (c *Context) String(code int, format string, a ...any)
• type Engine
  • func Default() *Engine
  • func New() *Engine
  • func (e *Engine) LoadHTMLFiles(files ...string)
  • func (e *Engine) LoadHTMLGlob(path string)
  • func (e *Engine) Run(addr string) error
  • func (e *Engine) RunTLS(addr, certFile, keyFile string) error
  • func (e *Engine) ServeHTTP(w http.ResponseWriter, req *http.Request)
  • func (e *Engine) SetFuncMap(funcMap template.FuncMap)
• type H
• type HandlerFunc
  • func BasicAuth(accounts Accounts) HandlerFunc
  • func BasicAuthForProxy(accounts Accounts) HandlerFunc
  • func BasicAuthForProxyWithRealm(accounts Accounts, realm string) HandlerFunc
  • func BasicAuthWithRealm(accounts Accounts, realm string) HandlerFunc
  • func Logger() HandlerFunc
  • func Recovery() HandlerFunc
• type RouterGroup
  • func (g *RouterGroup) Any(path string, handlers ...HandlerFunc)
  • func (g *RouterGroup) CONNECT(path string, handlers ...HandlerFunc)
  • func (g *RouterGroup) DELETE(path string, handlers ...HandlerFunc)
  • func (g *RouterGroup) GET(path string, handlers ...HandlerFunc)
  • func (g *RouterGroup) Group(prefix string, handlers ...HandlerFunc) *RouterGroup
  • func (g *RouterGroup) HEAD(path string, handlers ...HandlerFunc)
  • func (g *RouterGroup) OPTIONS(path string, handlers ...HandlerFunc)
  • func (g *RouterGroup) PATCH(path string, handlers ...HandlerFunc)
  • func (g *RouterGroup) POST(path string, handlers ...HandlerFunc)
  • func (g *RouterGroup) Static(relativePath, root string)
  • func (g *RouterGroup) TRACE(path string, handlers ...HandlerFunc)
  • func (g *RouterGroup) Use(middlewares ...HandlerFunc)

Constants

const (
	MIMEJSON      = "application/json"
	MIMEHTML      = "text/html"
	MIMEPlain     = "text/plain"
	MIMEPOSTForm  = "application/x-www-form-urlencoded"
	MIMEMultipart = "multipart/form-data"
)

const AuthProxyUserKey = "proxy_user"

const AuthUserKey = "user"

Types

type Accounts

type Accounts map[string]string

type Context

type Context struct {
	Writer  http.ResponseWriter
	Request *http.Request

	Path   string
	Method string
	Params httprouter.Params

	Keys       map[string]any
	StatusCode int
	Errors     []*error // Errors is a list of errors attached to all the handlers/middlewares
	// contains filtered or unexported fields
}

func (*Context) Abort

func (c *Context) Abort()

Abort Note that this will not stop the current handler, often followed by `return`

func (*Context) AbortWithStatus

func (c *Context) AbortWithStatus(code int)

func (*Context) Cookie

func (c *Context) Cookie(name string) (string, error)

func (*Context) Copy

func (c *Context) Copy() *Context

Copy returns a copy of the current context that can be safely used outside the request's scope. This has to be used when the context has to be passed to a goroutine.

func (*Context) Data

func (c *Context) Data(code int, contentType string, data []byte)

func (*Context) File

func (c *Context) File(filePath string)

func (*Context) Get

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

func (*Context) HTML

func (c *Context) HTML(code int, name string, data any)

func (*Context) HandlerName

func (c *Context) HandlerName() string

HandlerName returns the main handler's name

func (*Context) JSON

func (c *Context) JSON(code int, obj any)

func (*Context) MustGet

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

func (*Context) Next

func (c *Context) Next()

func (*Context) Param

func (c *Context) Param(key string) string

func (*Context) PostForm

func (c *Context) PostForm(key string) string

PostForm for x-www-form-urlencoded POST

func (*Context) Query

func (c *Context) Query(key string) string

func (*Context) Redirect

func (c *Context) Redirect(location string)

func (*Context) RemoteIP

func (c *Context) RemoteIP() string

func (*Context) Set

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

func (*Context) SetCookie

func (c *Context) SetCookie(
	name string,
	value string,
	maxAge int,
	path string,
	domain string,
	secure bool,
	httpOnly bool,
)

func (*Context) SetHeader

func (c *Context) SetHeader(key, value string)

func (*Context) Status

func (c *Context) Status(code int)

func (*Context) String

func (c *Context) String(code int, format string, a ...any)

type Engine

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

func Default

func Default() *Engine

Default use Logger & Recovery middlewares

func New

func New() *Engine

func (*Engine) LoadHTMLFiles

func (e *Engine) LoadHTMLFiles(files ...string)

func (*Engine) LoadHTMLGlob

func (e *Engine) LoadHTMLGlob(path string)

func (*Engine) Run

func (e *Engine) Run(addr string) error

func (*Engine) RunTLS

func (e *Engine) RunTLS(addr, certFile, keyFile string) error

func (*Engine) ServeHTTP

func (e *Engine) ServeHTTP(w http.ResponseWriter, req *http.Request)

func (*Engine) SetFuncMap

func (e *Engine) SetFuncMap(funcMap template.FuncMap)

SetFuncMap assume that only invoke one time

type H

type H map[string]any

type HandlerFunc

type HandlerFunc func(c *Context)

func BasicAuth

func BasicAuth(accounts Accounts) HandlerFunc

BasicAuth returns a Basic HTTP Authorization middleware.

func BasicAuthForProxy

func BasicAuthForProxy(accounts Accounts) HandlerFunc

BasicAuthForProxy returns a Basic HTTP Proxy Authorization middleware.

func BasicAuthForProxyWithRealm

func BasicAuthForProxyWithRealm(accounts Accounts, realm string) HandlerFunc

BasicAuthForProxyWithRealm If the realm is empty, "Proxy Authorization Required" will be used by default.

func BasicAuthWithRealm

func BasicAuthWithRealm(accounts Accounts, realm string) HandlerFunc

BasicAuthWithRealm If the realm is empty, "Authorization Required" will be used by default.

func Logger

func Logger() HandlerFunc

Logger middleware that top group use

func Recovery

func Recovery() HandlerFunc

type RouterGroup

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

func (*RouterGroup) Any

func (g *RouterGroup) Any(path string, handlers ...HandlerFunc)

func (*RouterGroup) CONNECT

func (g *RouterGroup) CONNECT(path string, handlers ...HandlerFunc)

func (*RouterGroup) DELETE

func (g *RouterGroup) DELETE(path string, handlers ...HandlerFunc)

func (*RouterGroup) GET

func (g *RouterGroup) GET(path string, handlers ...HandlerFunc)

func (*RouterGroup) Group

func (g *RouterGroup) Group(prefix string, handlers ...HandlerFunc) *RouterGroup

func (*RouterGroup) HEAD

func (g *RouterGroup) HEAD(path string, handlers ...HandlerFunc)

func (*RouterGroup) OPTIONS

func (g *RouterGroup) OPTIONS(path string, handlers ...HandlerFunc)

func (*RouterGroup) PATCH

func (g *RouterGroup) PATCH(path string, handlers ...HandlerFunc)

func (*RouterGroup) POST

func (g *RouterGroup) POST(path string, handlers ...HandlerFunc)

func (*RouterGroup) Static

func (g *RouterGroup) Static(relativePath, root string)

func (*RouterGroup) TRACE

func (g *RouterGroup) TRACE(path string, handlers ...HandlerFunc)

func (*RouterGroup) Use

func (g *RouterGroup) Use(middlewares ...HandlerFunc)