wgin

README

WGin

基於 Gin 的 Web 框架

Documentation

Index

• func Any[request, response any](router gin.IRoutes, path string, handler Handler[request, response])
• func DELETE[request, response any](router gin.IRoutes, path string, handler Handler[request, response])
• func Get[response any](router gin.IRoutes, path string, handler BaseHandler[response])
• func HEAD[request, response any](router gin.IRoutes, path string, handler Handler[request, response])
• func Handle[request, response any](router gin.IRoutes, method, path string, handler Handler[request, response])
• func OPTIONS[request, response any](router gin.IRoutes, path string, handler Handler[request, response])
• func PATCH[request, response any](router gin.IRoutes, path string, handler Handler[request, response])
• func POST[request, response any](router gin.IRoutes, path string, handler Handler[request, response])
• func PUT[request, response any](router gin.IRoutes, path string, handler Handler[request, response])
• func SetBindHandler(f BindHandler)
• func SetErrorHandler(f ErrorHandler)
• func SetResponseHandler(f ResponseHandler)
• func UseAny[request, response any](router gin.IRoutes, path string, handler Handler[request, response])
• func UseDELETE[request, response any](router gin.IRoutes, path string, handler Handler[request, response])
• func UseGet[response any](router gin.IRoutes, path string, handler BaseHandler[response])
• func UseHEAD[request, response any](router gin.IRoutes, path string, handler Handler[request, response])
• func UseHandle[request, response any](router gin.IRoutes, method, path string, handler Handler[request, response])
• func UseOPTIONS[request, response any](router gin.IRoutes, path string, handler Handler[request, response])
• func UsePATCH[request, response any](router gin.IRoutes, path string, handler Handler[request, response])
• func UsePOST[request, response any](router gin.IRoutes, path string, handler Handler[request, response])
• func UsePUT[request, response any](router gin.IRoutes, path string, handler Handler[request, response])
• type BaseContext
• type BaseHandler
  • func NewBaseHandler[response any](f BaseHandlerFunc[response]) BaseHandler[response]
  • func (h BaseHandler[T]) AddMiddleware(f gin.HandlerFunc, fs ...gin.HandlerFunc) BaseHandler[T]
  • func (h BaseHandler[T]) GetHandlers() []gin.HandlerFunc
  • func (h BaseHandler[T]) Handler() gin.HandlerFunc
  • func (h BaseHandler[T]) SetErrorHandler(f ErrorHandler) BaseHandler[T]
  • func (h BaseHandler[T]) SetResponseHandler(f ResponseHandler) BaseHandler[T]
• type BaseHandlerFunc
• type BindHandler
• type Context
  • func (c *Context[T]) GetBody() (*T, error)
• type ErrorHandler
• type GetBodyHandler
• type Handler
  • func NewHandler[request, response any](f HandlerFunc[request, response]) Handler[request, response]
  • func (h Handler[T, E]) AddMiddleware(f gin.HandlerFunc, fs ...gin.HandlerFunc) Handler[T, E]
  • func (h Handler[T, E]) GetHandlers() []gin.HandlerFunc
  • func (h Handler[T, E]) Handler() gin.HandlerFunc
  • func (h Handler[T, E]) SetErrorHandler(f ErrorHandler) Handler[T, E]
  • func (h Handler[T, E]) SetResponseHandler(f ResponseHandler) Handler[T, E]
• type HandlerFunc
• type ResponseHandler

Functions

func Any

func Any[request, response any](router gin.IRoutes, path string, handler Handler[request, response])

func DELETE

func DELETE[request, response any](router gin.IRoutes, path string, handler Handler[request, response])

func Get

func Get[response any](router gin.IRoutes, path string, handler BaseHandler[response])

func HEAD

func HEAD[request, response any](router gin.IRoutes, path string, handler Handler[request, response])

func Handle

func Handle[request, response any](router gin.IRoutes, method, path string, handler Handler[request, response])

func OPTIONS

func OPTIONS[request, response any](router gin.IRoutes, path string, handler Handler[request, response])

func PATCH

func PATCH[request, response any](router gin.IRoutes, path string, handler Handler[request, response])

func POST

func POST[request, response any](router gin.IRoutes, path string, handler Handler[request, response])

func PUT

func PUT[request, response any](router gin.IRoutes, path string, handler Handler[request, response])

func SetBindHandler

func SetBindHandler(f BindHandler)

SetBindHandler 設置預設 bind

func SetErrorHandler

func SetErrorHandler(f ErrorHandler)

SetErrorHandler 設置預設錯誤處理

func SetResponseHandler

func SetResponseHandler(f ResponseHandler)

SetResponseHandler 設置預設回應處理

func UseAny

func UseAny[request, response any](router gin.IRoutes, path string, handler Handler[request, response])

func UseDELETE

func UseDELETE[request, response any](router gin.IRoutes, path string, handler Handler[request, response])

func UseGet

func UseGet[response any](router gin.IRoutes, path string, handler BaseHandler[response])

func UseHEAD

func UseHEAD[request, response any](router gin.IRoutes, path string, handler Handler[request, response])

func UseHandle

func UseHandle[request, response any](router gin.IRoutes, method, path string, handler Handler[request, response])

func UseOPTIONS

func UseOPTIONS[request, response any](router gin.IRoutes, path string, handler Handler[request, response])

func UsePATCH

func UsePATCH[request, response any](router gin.IRoutes, path string, handler Handler[request, response])

func UsePOST

func UsePOST[request, response any](router gin.IRoutes, path string, handler Handler[request, response])

func UsePUT

func UsePUT[request, response any](router gin.IRoutes, path string, handler Handler[request, response])

Types

type BaseContext

type BaseContext = *gin.Context

type BaseHandler

type BaseHandler[response any] struct {
	Middleware      []gin.HandlerFunc
	ErrorHandler    ErrorHandler
	ResponseHandler ResponseHandler
	HandlerFunc     BaseHandlerFunc[response]
}

BaseHandler 沒有 request

func NewBaseHandler

func NewBaseHandler[response any](f BaseHandlerFunc[response]) BaseHandler[response]

func (BaseHandler[T]) AddMiddleware

func (h BaseHandler[T]) AddMiddleware(f gin.HandlerFunc, fs ...gin.HandlerFunc) BaseHandler[T]

AddMiddleware 添加中間件

func (BaseHandler[T]) GetHandlers

func (h BaseHandler[T]) GetHandlers() []gin.HandlerFunc

GetHandlers 取得 []gin.HandlerFunc

func (BaseHandler[T]) Handler

func (h BaseHandler[T]) Handler() gin.HandlerFunc

Handler 處理 HandlerFunc 後 依據條件處理 ErrorHandler ResponseHandler

func (BaseHandler[T]) SetErrorHandler

func (h BaseHandler[T]) SetErrorHandler(f ErrorHandler) BaseHandler[T]

SetErrorHandler 設置錯誤處理函數

func (BaseHandler[T]) SetResponseHandler

func (h BaseHandler[T]) SetResponseHandler(f ResponseHandler) BaseHandler[T]

SetResponseHandler 設置回應處理函數

type BaseHandlerFunc

type BaseHandlerFunc[response any] func(*gin.Context) (*response, error)

type BindHandler

type BindHandler func(c *gin.Context, a any) error

type Context

type Context[T any] struct {
	BaseContext
	// contains filtered or unexported fields
}

func (*Context[T]) GetBody

func (c *Context[T]) GetBody() (*T, error)

type ErrorHandler

type ErrorHandler func(c *gin.Context, err error)

type GetBodyHandler

type GetBodyHandler[T any] func(*Context[T]) (*T, error)

type Handler

type Handler[request, response any] struct {
	BaseHandler[response]
	GetBodyHandler GetBodyHandler[request]
	HandlerFunc    HandlerFunc[request, response]
}

Handler 有 request 和 response

func NewHandler

func NewHandler[request, response any](f HandlerFunc[request, response]) Handler[request, response]

func (Handler[T, E]) AddMiddleware

func (h Handler[T, E]) AddMiddleware(f gin.HandlerFunc, fs ...gin.HandlerFunc) Handler[T, E]

AddMiddleware 添加中間件

func (Handler[T, E]) GetHandlers

func (h Handler[T, E]) GetHandlers() []gin.HandlerFunc

GetHandlers 取得 []gin.HandlerFunc

func (Handler[T, E]) Handler

func (h Handler[T, E]) Handler() gin.HandlerFunc

Handler 取得 gin.HandlerFunc

func (Handler[T, E]) SetErrorHandler

func (h Handler[T, E]) SetErrorHandler(f ErrorHandler) Handler[T, E]

SetErrorHandler 設置錯誤處理函數

func (Handler[T, E]) SetResponseHandler

func (h Handler[T, E]) SetResponseHandler(f ResponseHandler) Handler[T, E]

SetResponseHandler 設置回應處理函數

type HandlerFunc

type HandlerFunc[request, response any] func(ctx *Context[request]) (*response, error)

type ResponseHandler

type ResponseHandler func(c *gin.Context, a any)