ginext

Documentation

Overview

Package ginext provides extensions for the Gin web framework.

Index

• type Context
• type Engine
  • func New(ginMode string) *Engine
  • func (e *Engine) DELETE(relativePath string, handlers ...HandlerFunc)
  • func (e *Engine) GET(relativePath string, handlers ...HandlerFunc)
  • func (e *Engine) Group(relativePath string, handlers ...HandlerFunc) *RouterGroup
  • func (e *Engine) HEAD(relativePath string, handlers ...HandlerFunc)
  • func (e *Engine) LoadHTMLGlob(pattern string)
  • func (e *Engine) OPTIONS(relativePath string, handlers ...HandlerFunc)
  • func (e *Engine) PATCH(relativePath string, handlers ...HandlerFunc)
  • func (e *Engine) POST(relativePath string, handlers ...HandlerFunc)
  • func (e *Engine) PUT(relativePath string, handlers ...HandlerFunc)
  • func (e *Engine) Run(addr ...string) error
  • func (e *Engine) Use(middleware ...HandlerFunc)
• type H
• type HandlerFunc
  • func Logger() HandlerFunc
  • func Recovery() HandlerFunc
• type RouterGroup
  • func (g *RouterGroup) DELETE(relativePath string, handlers ...HandlerFunc)
  • func (g *RouterGroup) GET(relativePath string, handlers ...HandlerFunc)
  • func (g *RouterGroup) HEAD(relativePath string, handlers ...HandlerFunc)
  • func (g *RouterGroup) OPTIONS(relativePath string, handlers ...HandlerFunc)
  • func (g *RouterGroup) PATCH(relativePath string, handlers ...HandlerFunc)
  • func (g *RouterGroup) POST(relativePath string, handlers ...HandlerFunc)
  • func (g *RouterGroup) PUT(relativePath string, handlers ...HandlerFunc)
  • func (g *RouterGroup) Use(middleware ...HandlerFunc)

Types

type Context

type Context = gin.Context

Context is an alias for gin.Context.

type Engine

type Engine struct {
	*gin.Engine
}

Engine extends the standard Gin Engine.

func New

func New(ginMode string) *Engine

New creates a new Engine instance with the specified Gin mode.

func (*Engine) DELETE

func (e *Engine) DELETE(relativePath string, handlers ...HandlerFunc)

DELETE registers a handler for HTTP DELETE method on the Engine.

func (*Engine) GET

func (e *Engine) GET(relativePath string, handlers ...HandlerFunc)

GET registers a handler for HTTP GET method on the Engine.

func (*Engine) Group

func (e *Engine) Group(relativePath string, handlers ...HandlerFunc) *RouterGroup

Group creates a new route group.

func (*Engine) HEAD

func (e *Engine) HEAD(relativePath string, handlers ...HandlerFunc)

HEAD registers a handler for HTTP HEAD method on the Engine.

func (*Engine) LoadHTMLGlob

func (e *Engine) LoadHTMLGlob(pattern string)

LoadHTMLGlob loads HTML templates.

func (*Engine) OPTIONS

func (e *Engine) OPTIONS(relativePath string, handlers ...HandlerFunc)

OPTIONS registers a handler for HTTP OPTIONS method on the Engine.

func (*Engine) PATCH

func (e *Engine) PATCH(relativePath string, handlers ...HandlerFunc)

PATCH registers a handler for HTTP PATCH method on the Engine.

func (*Engine) POST

func (e *Engine) POST(relativePath string, handlers ...HandlerFunc)

POST registers a handler for HTTP POST method on the Engine.

func (*Engine) PUT

func (e *Engine) PUT(relativePath string, handlers ...HandlerFunc)

PUT registers a handler for HTTP PUT method on the Engine.

func (*Engine) Run

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

Run starts the Gin server.

func (*Engine) Use

func (e *Engine) Use(middleware ...HandlerFunc)

Use attaches middleware to the Engine.

type H

type H = gin.H

H is an alias for gin.H.

type HandlerFunc

type HandlerFunc = gin.HandlerFunc

HandlerFunc is an alias for gin.HandlerFunc.

func Logger

func Logger() HandlerFunc

Logger returns the default Gin logger middleware.

func Recovery

func Recovery() HandlerFunc

Recovery returns the default Gin recovery middleware.

type RouterGroup

type RouterGroup struct {
	*gin.RouterGroup
}

RouterGroup groups related routes together.

func (*RouterGroup) DELETE

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

DELETE registers a handler for HTTP DELETE method on the RouterGroup.

func (*RouterGroup) GET

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

GET registers a handler for HTTP GET method on the RouterGroup.

func (*RouterGroup) HEAD

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

HEAD registers a handler for HTTP HEAD method on the RouterGroup.

func (*RouterGroup) OPTIONS

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

OPTIONS registers a handler for HTTP OPTIONS method on the RouterGroup.

func (*RouterGroup) PATCH

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

PATCH registers a handler for HTTP PATCH method on the RouterGroup.

func (*RouterGroup) POST

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

POST registers a handler for HTTP POST method on the RouterGroup.

func (*RouterGroup) PUT

func (g *RouterGroup) PUT(relativePath string, handlers ...HandlerFunc)

PUT registers a handler for HTTP PUT method on the RouterGroup.

func (*RouterGroup) Use

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

Use attaches middleware to the RouterGroup.