gin

package module

Go to main page

Versions in this module

v1

v1.7.2

May 8, 2021

Changes in this version

+ var ErrEmptyAuthHeader = errors.New("auth标头为空")

+ var ErrEmptyCookieToken = errors.New(" Cookie token为空")

+ var ErrEmptyParamToken = errors.New("参数token为空")

+ var ErrEmptyQueryToken = errors.New("查询token为空")

+ var ErrExpiredToken = errors.New("token已过期")

+ var ErrFailedAuthentication = errors.New("用户名或密码错误")

+ var ErrFailedTokenCreation = errors.New("无法创建JWT Token")

+ var ErrForbidden = errors.New("您无权访问此资源")

+ var ErrInvalidAuthHeader = errors.New("auth标头无效")

+ var ErrInvalidPrivateKey = errors.New("私钥无效")

+ var ErrInvalidPubKey = errors.New("公钥无效")

+ var ErrInvalidSigningAlgorithm = errors.New("无效签名算法")

+ var ErrMissingAuthFunc = errors.New(" JWTMiddleware.AuthFunc函数未定义!")

+ var ErrMissingExpField = errors.New("缺少exp字段")

+ var ErrMissingLoginValues = errors.New("缺少用户名或密码")

+ var ErrMissingSecretKey = errors.New("需要密钥")

+ var ErrNoPrivateKeyFile = errors.New("私钥文件不可读")

+ var ErrNoPubKeyFile = errors.New("公钥文件不可读")

+ var ErrWrongFormatOfExp = errors.New("exp必须为float64格式")

+ var IdentityKey = "identity"

+ func AddGenOne(handleFuncName, routerPath string, methods []string)

+ func FindTag(obj interface{}, field, tag string) string

+ func GetStringList(list []string) string

+ func GetToken(c *Context) string

+ func UnMarshal(name string) string

+ type APIFunc func(*Context) interface

+ type Base struct

+ func (b *Base) BasePath(router IRoute) string

+ func (b *Base) Model(middleware APIFunc) *Base

+ func (b *Base) Register(router IRoute, cList []interface{}) bool

+ func (b *Base) SetDev(isDev bool)

+ func (b *Base) SetOutDoc(outDoc bool)

+ type BeforeAfter struct

+ C *Context

+ Ctx context.Context

+ Error error

+ FuncName string

+ Param interface{}

+ Response interface{}

type Context

+ func (c *Context) Cors() HandlerFunc

+ func (c *Context) IsAjax() bool

+ type DefaultBeforeAfter struct

+ func (d *DefaultBeforeAfter) After(r *BeforeAfter) bool

+ func (d *DefaultBeforeAfter) Before(r *BeforeAfter) bool

type Engine

+ func (engine *Engine) New() *Base

+ type ErrorFunc func(interface{})

+ type Hook interface

+ After func(r *BeforeAfter) bool

+ Before func(r *BeforeAfter) bool

+ type JWTMiddleware struct

+ AuthAfter func(data interface{}, c *Context) bool

+ AuthFunc func(c *Context) (interface{}, error)

+ CookieDomain string

+ CookieHTTPOnly bool

+ CookieMaxAge time.Duration

+ CookieName string

+ CookieSameSite http.SameSite

+ DisabledAbort bool

+ HTTPStatusMsgFunc func(e error, c *Context) string

+ IdentityHandler func(*Context) interface{}

+ IdentityKey string

+ Key []byte

+ LoginResponse func(*Context, int, string, time.Time)

+ LogoutResponse func(*Context, int)

+ MaxRefresh time.Duration

+ PayloadFunc func(data interface{}) MapClaims

+ PrivateKeyByte []byte

+ PrivateKeyFile string

+ PubKeyByte []byte

+ PubKeyFile string

+ Realm string

+ RefreshResponse func(*Context, int, string, time.Time)

+ SecureCookie bool

+ SendAuthorization bool

+ SendCookie bool

+ SigningAlgorithm string

+ TimeFunc func() time.Time

+ Timeout time.Duration

+ TokenHeadName string

+ TokenLookup string

+ UnAuthFunc func(*Context, int, string)

+ func NewJWT(m *JWTMiddleware) (*JWTMiddleware, error)

+ func (mw *JWTMiddleware) CheckIfTokenExpire(c *Context) (jwt.MapClaims, error)

+ func (mw *JWTMiddleware) GetClaimsFromJWT(c *Context) (MapClaims, error)

+ func (mw *JWTMiddleware) Init() error

+ func (mw *JWTMiddleware) LoginHandler(c *Context)

+ func (mw *JWTMiddleware) LogoutHandler(c *Context)

+ func (mw *JWTMiddleware) MiddlewareFunc() HandlerFunc

+ func (mw *JWTMiddleware) ParseToken(c *Context) (*jwt.Token, error)

+ func (mw *JWTMiddleware) ParseTokenStr(token string) (*jwt.Token, error)

+ func (mw *JWTMiddleware) RefreshHandler(c *Context)

+ func (mw *JWTMiddleware) RefreshToken(c *Context) (string, time.Time, error)

+ func (mw *JWTMiddleware) TokenGenerate(data interface{}) (string, time.Time, error)

+ type List []interface

+ type MapClaims map[string]interface

+ func ExtractClaims(c *Context) MapClaims

+ func ExtractClaimsFromToken(token *jwt.Token) MapClaims

+ type RespBody struct

+ Code int

+ Data interface{}

+ Error string

+ State bool

v1.7.1

Apr 21, 2021

v1.6.3

Mar 17, 2021

v1.6.0

Apr 3, 2021

v1.2.0

Apr 3, 2021

Changes in this version

+ const TimeFormat

+ type Time time.Time

+ func (t *Time) Local() Time

+ func (t *Time) Now() Time

+ func (t *Time) Scan(v interface{}) error

+ func (t *Time) UTC() Time

+ func (t *Time) UnmarshalJSON(data []byte) (err error)

+ func (t Time) MarshalJSON() ([]byte, error)

+ func (t Time) String() string

+ func (t Time) Value() (driver.Value, error)

v1.0.2

Apr 5, 2021

Changes in this version

type Context

+ func (c *Context) Form(key string) string

+ func (c *Context) FormArray(key string) []string

+ func (c *Context) FormDefault(key, defaultValue string) string

+ func (c *Context) FormMap(key string) map[string]string

v1.0.1

Apr 4, 2021

v1.0.0

Apr 4, 2021

Changes in this version

+ const DefaultLogFlag

+ const DefaultLogLevel

+ const DefaultLogPrefix

+ func NewValid() *gvalid.Validator

type Context

+ func (c *Context) CORS() HandlerFunc

+ func (c *Context) DefaultPostForm(key, defaultValue string) string

+ func (c *Context) DefaultQuery(key, defaultValue string) string

+ func (c *Context) GetPostForm(key string) (string, bool)

+ func (c *Context) GetPostFormArray(key string) ([]string, bool)

+ func (c *Context) GetPostFormMap(key string) (map[string]string, bool)

+ func (c *Context) GetQuery(key string) (string, bool)

+ func (c *Context) GetQueryArray(key string) ([]string, bool)

+ func (c *Context) GetQueryMap(key string) (map[string]string, bool)

+ func (c *Context) MultipartForm() (*multipart.Form, error)

+ func (c *Context) ParseOnce(obj interface{}, b bind.IBind) error

+ type DiscardLogger struct

+ func (DiscardLogger) Debug(v ...interface{})

+ func (DiscardLogger) Debugf(format string, v ...interface{})

+ func (DiscardLogger) Error(v ...interface{})

+ func (DiscardLogger) Errorf(format string, v ...interface{})

+ func (DiscardLogger) Info(v ...interface{})

+ func (DiscardLogger) Infof(format string, v ...interface{})

+ func (DiscardLogger) Level() LogLevel

+ func (DiscardLogger) SetLevel(l LogLevel)

+ func (DiscardLogger) Warn(v ...interface{})

+ func (DiscardLogger) Warnf(format string, v ...interface{})

+ type ILogger interface

+ Debug func(v ...interface{})

+ Debugf func(format string, v ...interface{})

+ Error func(v ...interface{})

+ Errorf func(format string, v ...interface{})

+ Info func(v ...interface{})

+ Infof func(format string, v ...interface{})

+ Level func() LogLevel

+ SetLevel func(l LogLevel)

+ Warn func(v ...interface{})

+ Warnf func(format string, v ...interface{})

+ type IResponseWriter interface

+ Pusher func() http.Pusher

+ Size func() int

+ Status func() int

+ WriteHeaderNow func()

+ WriteStr func(string) (int, error)

+ Written func() bool

+ type LogLevel int

+ const LogDebug

+ const LogErr

+ const LogInfo

+ const LogOff

+ const LogUnknown

+ const LogWarning

+ type SimpleLogger struct

+ DEBUG *log.Logger

+ ERR *log.Logger

+ INFO *log.Logger

+ WARN *log.Logger

+ func NewSimpleLogger(out io.Writer) *SimpleLogger

+ func NewSimpleLogger2(out io.Writer, prefix string, flag int) *SimpleLogger

+ func NewSimpleLogger3(out io.Writer, prefix string, flag int, l LogLevel) *SimpleLogger

+ func (s *SimpleLogger) Debug(v ...interface{})

+ func (s *SimpleLogger) Debugf(format string, v ...interface{})

+ func (s *SimpleLogger) Error(v ...interface{})

+ func (s *SimpleLogger) Errorf(format string, v ...interface{})

+ func (s *SimpleLogger) Info(v ...interface{})

+ func (s *SimpleLogger) Infof(format string, v ...interface{})

+ func (s *SimpleLogger) Level() LogLevel

+ func (s *SimpleLogger) SetLevel(l LogLevel)

+ func (s *SimpleLogger) Warn(v ...interface{})

+ func (s *SimpleLogger) Warnf(format string, v ...interface{})

v0

v0.1.0

Apr 21, 2021

Changes in this version

+ const AuthUserKey

+ const BindKey

+ const BodyBytesKey

+ const DebugMode

+ const EnvGinMode

+ const MiMeHTML

+ const MiMeJSON

+ const MiMeMultipartPOSTForm

+ const MiMePOSTForm

+ const MiMePlain

+ const MiMeXML

+ const MiMeXML2

+ const MiMeYAML

+ const ReleaseMode

+ const TestMode

+ var DebugPrintRouteFunc func(httpMethod, absolutePath, handlerName string, nuHandlers int)

+ var DefaultErrorWriter io.Writer = os.Stderr

+ var DefaultWriter io.Writer = os.Stdout

+ func CreateTestContext(w http.ResponseWriter) (c *Context, r *Engine)

+ func Dir(root string, listDirectory bool) http.FileSystem

+ func DisableBindValidation()

+ func DisableConsoleColor()

+ func EnableJsonDecoderDisallowUnknownFields()

+ func EnableJsonDecoderUseNumber()

+ func ForceConsoleColor()

+ func IsDebugging() bool

+ func Mode() string

+ func SetMode(value string)

+ type Accounts map[string]string

+ type Context struct

+ Accepted []string

+ Errors errorMsgs

+ Keys map[string]interface{}

+ Params Params

+ Request *http.Request

+ Writer ResponseWriter

+ func (c *Context) Abort()

+ func (c *Context) AbortWithError(code int, err error) *Error

+ func (c *Context) AbortWithStatus(code int)

+ func (c *Context) AbortWithStatusJSON(code int, jsonObj interface{})

+ func (c *Context) AsciiJSON(code int, obj interface{})

+ func (c *Context) BindWith(obj interface{}, b bind.IBind) error

+ func (c *Context) ClientIP() string

+ func (c *Context) ContentType() string

+ 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) DataFromReader(code int, contentLength int64, contentType string, reader io.Reader, ...)

+ func (c *Context) Deadline() (deadline time.Time, ok bool)

+ func (c *Context) Done() <-chan struct{}

+ func (c *Context) Err() error

+ func (c *Context) Error(err error) *Error

+ func (c *Context) File(filepath string)

+ func (c *Context) FileAttachment(filepath, filename string)

+ func (c *Context) FileFromFS(filepath string, fs http.FileSystem)

+ func (c *Context) FormFile(name string) (*multipart.FileHeader, error)

+ func (c *Context) FormMultipart() (*multipart.Form, error)

+ func (c *Context) FullPath() string

+ func (c *Context) Get(key string) (value interface{}, exists bool)

+ func (c *Context) GetBool(key string) (b bool)

+ func (c *Context) GetDuration(key string) (d time.Duration)

+ func (c *Context) GetFloat64(key string) (f64 float64)

+ func (c *Context) GetHeader(key string) string

+ func (c *Context) GetInt(key string) (i int)

+ func (c *Context) GetInt64(key string) (i64 int64)

+ func (c *Context) GetRawData() ([]byte, error)

+ func (c *Context) GetString(key string) (s string)

+ func (c *Context) GetStringMap(key string) (sm map[string]interface{})

+ func (c *Context) GetStringMapString(key string) (sms map[string]string)

+ func (c *Context) GetStringMapStringSlice(key string) (smss map[string][]string)

+ func (c *Context) GetStringSlice(key string) (ss []string)

+ func (c *Context) GetTime(key string) (t time.Time)

+ func (c *Context) GetUint(key string) (ui uint)

+ func (c *Context) GetUint64(key string) (ui64 uint64)

+ func (c *Context) HTML(code int, name string, obj interface{})

+ func (c *Context) Handler() HandlerFunc

+ func (c *Context) HandlerName() string

+ func (c *Context) HandlerNames() []string

+ func (c *Context) Header(key, value string)

+ func (c *Context) IndentedJSON(code int, obj interface{})

+ func (c *Context) IsAborted() bool

+ func (c *Context) IsWebsocket() bool

+ func (c *Context) JSON(code int, obj interface{})

+ func (c *Context) JSONP(code int, obj interface{})

+ func (c *Context) MustGet(key string) interface{}

+ func (c *Context) Negotiate(code int, config Negotiate)

+ func (c *Context) NegotiateFormat(offered ...string) string

+ func (c *Context) Next()

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

+ func (c *Context) Parse(obj interface{}) error

+ func (c *Context) ParseBody(obj interface{}) (err error)

+ func (c *Context) ParseUri(obj interface{}) error

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

+ func (c *Context) PostFormArray(key string) []string

+ func (c *Context) PostFormDefault(key, defaultValue string) string

+ func (c *Context) PostFormMap(key string) map[string]string

+ func (c *Context) ProtoBuf(code int, obj interface{})

+ func (c *Context) PureJSON(code int, obj interface{})

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

+ func (c *Context) QueryArray(key string) []string

+ func (c *Context) QueryDefault(key, defaultValue string) string

+ func (c *Context) QueryMap(key string) map[string]string

+ func (c *Context) Redirect(code int, location string)

+ func (c *Context) RemoteIP() (net.IP, bool)

+ func (c *Context) Render(code int, r render.Render)

+ func (c *Context) SSEvent(name string, message interface{})

+ func (c *Context) SaveUploadedFile(file *multipart.FileHeader, dst string) error

+ func (c *Context) SecureJSON(code int, obj interface{})

+ func (c *Context) Set(key string, value interface{})

+ func (c *Context) SetAccepted(formats ...string)

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

+ func (c *Context) SetSameSite(samesite http.SameSite)

+ func (c *Context) Status(code int)

+ func (c *Context) Stream(step func(w io.Writer) bool) bool

+ func (c *Context) String(code int, format string, values ...interface{})

+ func (c *Context) Value(key interface{}) interface{}

+ func (c *Context) XML(code int, obj interface{})

+ func (c *Context) YAML(code int, obj interface{})

+ type Engine struct

+ AppEngine bool

+ ForwardedByClientIP bool

+ FuncMap template.FuncMap

+ HTMLRender render.HTMLRender

+ HandleMethodNotAllowed bool

+ MaxMultipartMemory int64

+ RedirectFixedPath bool

+ RedirectTrailingSlash bool

+ RemoteIPHeaders []string

+ RemoveExtraSlash bool

+ TrustedProxies []string

+ UnescapePathValues bool

+ UseRawPath bool

+ func Default() *Engine

+ func New() *Engine

+ func (engine *Engine) Delims(left, right string) *Engine

+ func (engine *Engine) HandleContext(c *Context)

+ func (engine *Engine) LoadHTMLFiles(files ...string)

+ func (engine *Engine) LoadHTMLGlob(pattern string)

+ func (engine *Engine) NoMethod(handlers ...HandlerFunc)

+ func (engine *Engine) NoRoute(handlers ...HandlerFunc)

+ func (engine *Engine) Routes() (routes RoutesInfo)

+ func (engine *Engine) Run(addr ...string) (err error)

+ func (engine *Engine) RunFd(fd int) (err error)

+ func (engine *Engine) RunListener(listener net.Listener) (err error)

+ func (engine *Engine) RunTLS(addr, certFile, keyFile string) (err error)

+ func (engine *Engine) RunUnix(file string) (err error)

+ func (engine *Engine) SecureJsonPrefix(prefix string) *Engine

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

+ func (engine *Engine) SetFuncMap(funcMap template.FuncMap)

+ func (engine *Engine) SetHTMLTemplate(templ *template.Template)

+ func (engine *Engine) Use(middleware ...HandlerFunc) IRoute

+ type Error struct

+ Err error

+ Meta interface{}

+ Type ErrorType

+ func (msg *Error) IsType(flags ErrorType) bool

+ func (msg *Error) JSON() interface{}

+ func (msg *Error) MarshalJSON() ([]byte, error)

+ func (msg *Error) SetMeta(data interface{}) *Error

+ func (msg *Error) SetType(flags ErrorType) *Error

+ func (msg *Error) Unwrap() error

+ func (msg Error) Error() string

+ type ErrorType uint64

+ const ErrorTypeAny

+ const ErrorTypeBind

+ const ErrorTypeNu

+ const ErrorTypePrivate

+ const ErrorTypePublic

+ const ErrorTypeRender

+ type H map[string]interface

+ func (h H) MarshalXML(e *xml.Encoder, start xml.StartElement) error

+ type HandlerFunc func(*Context)

+ func BasicAuth(accounts Accounts) HandlerFunc

+ func BasicAuthForRealm(accounts Accounts, realm string) HandlerFunc

+ func Bind(val interface{}) HandlerFunc

+ func CustomRecovery(handle RecoveryFunc) HandlerFunc

+ func CustomRecoveryWithWriter(out io.Writer, handle RecoveryFunc) HandlerFunc

+ func ErrorLogger() HandlerFunc

+ func ErrorLoggerT(typ ErrorType) HandlerFunc

+ func Logger() HandlerFunc

+ func LoggerWithConfig(conf LoggerConfig) HandlerFunc

+ func LoggerWithFormatter(f LogFormatter) HandlerFunc

+ func LoggerWithWriter(out io.Writer, notlogged ...string) HandlerFunc

+ func Recovery() HandlerFunc

+ func RecoveryWithWriter(out io.Writer, recovery ...RecoveryFunc) HandlerFunc

+ func WrapF(f http.HandlerFunc) HandlerFunc

+ func WrapH(h http.Handler) HandlerFunc

+ type HandlersChain []HandlerFunc

+ func (c HandlersChain) Last() HandlerFunc

+ type IRoute interface

+ Any func(string, ...HandlerFunc) IRoute

+ DELETE func(string, ...HandlerFunc) IRoute

+ GET func(string, ...HandlerFunc) IRoute

+ HEAD func(string, ...HandlerFunc) IRoute

+ Handle func(string, string, ...HandlerFunc) IRoute

+ OPTIONS func(string, ...HandlerFunc) IRoute

+ PATCH func(string, ...HandlerFunc) IRoute

+ POST func(string, ...HandlerFunc) IRoute

+ PUT func(string, ...HandlerFunc) IRoute

+ Static func(string, string) IRoute

+ StaticFS func(string, http.FileSystem) IRoute

+ StaticFile func(string, string) IRoute

+ Use func(...HandlerFunc) IRoute

+ type IRouter interface

+ Group func(string, ...HandlerFunc) *RouterGroup

+ type LogFormatter func(params LogFormatterParams) string

+ type LogFormatterParams struct

+ BodySize int

+ ClientIP string

+ ErrorMessage string

+ Keys map[string]interface{}

+ Latency time.Duration

+ Method string

+ Path string

+ Request *http.Request

+ StatusCode int

+ TimeStamp time.Time

+ func (p *LogFormatterParams) IsOutputColor() bool

+ func (p *LogFormatterParams) MethodColor() string

+ func (p *LogFormatterParams) ResetColor() string

+ func (p *LogFormatterParams) StatusCodeColor() string

+ type LoggerConfig struct

+ Formatter LogFormatter

+ Output io.Writer

+ SkipPaths []string

+ type Negotiate struct

+ Data interface{}

+ HTMLData interface{}

+ HTMLName string

+ JSONData interface{}

+ Offered []string

+ XMLData interface{}

+ YAMLData interface{}

+ type Param struct

+ Key string

+ Value string

+ type Params []Param

+ func (ps Params) ByName(name string) (va string)

+ func (ps Params) Get(name string) (string, bool)

+ type RecoveryFunc func(c *Context, err interface{})

+ type ResponseWriter interface

+ Pusher func() http.Pusher

+ Size func() int

+ Status func() int

+ WriteHeaderNow func()

+ WriteString func(string) (int, error)

+ Written func() bool

+ type RouteInfo struct

+ Handler string

+ HandlerFunc HandlerFunc

+ Method string

+ Path string

+ type RouterGroup struct

+ Handlers HandlersChain

+ func (group *RouterGroup) Any(relativePath string, handlers ...HandlerFunc) IRoute

+ func (group *RouterGroup) BasePath() string

+ func (group *RouterGroup) DELETE(relativePath string, handlers ...HandlerFunc) IRoute

+ func (group *RouterGroup) GET(relativePath string, handlers ...HandlerFunc) IRoute

+ func (group *RouterGroup) Group(relativePath string, handlers ...HandlerFunc) *RouterGroup

+ func (group *RouterGroup) HEAD(relativePath string, handlers ...HandlerFunc) IRoute

+ func (group *RouterGroup) Handle(httpMethod, relativePath string, handlers ...HandlerFunc) IRoute

+ func (group *RouterGroup) OPTIONS(relativePath string, handlers ...HandlerFunc) IRoute

+ func (group *RouterGroup) PATCH(relativePath string, handlers ...HandlerFunc) IRoute

+ func (group *RouterGroup) POST(relativePath string, handlers ...HandlerFunc) IRoute

+ func (group *RouterGroup) PUT(relativePath string, handlers ...HandlerFunc) IRoute

+ func (group *RouterGroup) Static(relativePath, root string) IRoute

+ func (group *RouterGroup) StaticFS(relativePath string, fs http.FileSystem) IRoute

+ func (group *RouterGroup) StaticFile(relativePath, filepath string) IRoute

+ func (group *RouterGroup) Use(middleware ...HandlerFunc) IRoute

+ type RoutesInfo []RouteInfo

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL