Documentation
¶
Index ¶
- Constants
- Variables
- func Bind(ctx *gin.Context, obj interface{}) error
- func DefaultBinding(ctx *gin.Context) binding.Binding
- func DefaultRender(ctx *gin.Context, obj interface{}) render.Render
- func LogFormatter(layout string) func(param gin.LogFormatterParams) string
- func LogFormatterWithExtra(layout string, getExtra func(param gin.LogFormatterParams) string) func(param gin.LogFormatterParams) string
- func MustBind(ctx *gin.Context, obj interface{}) error
- func RecoverHandler(c *gin.Context, err interface{}) error
- func Recovery(opts ...RecoveryOption) gin.HandlerFunc
- func RecoveryWithWriter(out io.Writer, opts ...RecoveryOption) gin.HandlerFunc
- func Redirect(code int, path string) gin.HandlerFunc
- func RedirectTrim(code int, prefix string) gin.HandlerFunc
- func RequestIDFromGinContext(ctx *gin.Context) string
- func ShouldBind(ctx *gin.Context, obj interface{}) error
- func UseHTTPPreflight() gin.HandlerFunc
- func WrapGinF(f gin.HandlerFunc) http.HandlerFunc
- func XRequestId(keys ...interface{}) gin.HandlerFunc
- type EmptyRecoveryOption
- type RecoveryOption
- type RecoveryOptionFunc
Constants ¶
const DateTime = "2006/01/02 - 15:04:05"
Variables ¶
var NopHandlerFunc = gin.HandlerFunc(func(c *gin.Context) { if c == nil { return } c.Next() })
Functions ¶
func DefaultBinding ¶
Default returns the appropriate Binding instance based on the HTTP method and the content type.
func DefaultRender ¶
DefaultRender returns the appropriate Binding instance based on the HTTP method and the content type.
func LogFormatter ¶ added in v1.2.88
func LogFormatter(layout string) func(param gin.LogFormatterParams) string
LogFormatter is the log format function gin.Logger middleware uses.
func LogFormatterWithExtra ¶ added in v1.2.99
func LogFormatterWithExtra(layout string, getExtra func(param gin.LogFormatterParams) string) func(param gin.LogFormatterParams) string
LogFormatterWithExtra is the log format function gin.Logger middleware uses with extra append {path}.
func MustBind ¶
MustBindWith binds the passed struct pointer using the specified binding engine. It will abort the request with HTTP 400 if any error occurs. See the binding package.
func RecoverHandler ¶
func Recovery ¶
func Recovery(opts ...RecoveryOption) gin.HandlerFunc
Recovery returns a middleware that recovers from any panics and writes a 500 if there was one.
func RecoveryWithWriter ¶
func RecoveryWithWriter(out io.Writer, opts ...RecoveryOption) gin.HandlerFunc
RecoveryWithWriter returns a middleware for a given writer that recovers from any panics and writes a 500 if there was one.
func RedirectTrim ¶
func RedirectTrim(code int, prefix string) gin.HandlerFunc
func RequestIDFromGinContext ¶
func ShouldBind ¶
ShouldBind binds the passed struct pointer using the specified binding engine. See the binding package.
func UseHTTPPreflight ¶
func UseHTTPPreflight() gin.HandlerFunc
func WrapGinF ¶
func WrapGinF(f gin.HandlerFunc) http.HandlerFunc
WrapGinF is a helper function for wrapping gin.HandlerFunc Returns a http middleware
func XRequestId ¶
func XRequestId(keys ...interface{}) gin.HandlerFunc
XRequestId returns a new server interceptors with x-request-id in context.
Types ¶
type EmptyRecoveryOption ¶
type EmptyRecoveryOption struct{}
EmptyRecoveryOption does not alter the configuration. It can be embedded in another structure to build custom options.
This API is EXPERIMENTAL.
type RecoveryOption ¶
type RecoveryOption interface {
// contains filtered or unexported methods
}
A RecoveryOption sets options.
func WithRecoveryHandler ¶
func WithRecoveryHandler(f func(c *gin.Context, err interface{}) error) RecoveryOption
WithRecoveryHandler set a recover handler if panic
type RecoveryOptionFunc ¶
type RecoveryOptionFunc func(*recovery)
RecoveryOptionFunc wraps a function that modifies recovery into an implementation of the RecoveryOption interface.
Source Files
Directories