gin

package module

Go to main page

Versions in this module

v0

v0.0.24

Mar 18, 2023

v0.0.23

Mar 17, 2023

v0.0.22

Mar 17, 2023

Changes in this version

type ExtRbacConfig

+ Whitelist map[string]bool

+ func (r *ExtRbacConfig) IsWhiteList(in string) bool

+ func (r *ExtRbacConfig) Object() *casbin.Enforcer

+ type RbacInterface interface

+ IsWhiteList func(string) bool

+ Object func() *casbin.Enforcer

v0.0.21

Mar 13, 2023

v0.0.20

Mar 12, 2023

Changes in this version

+ const ClientMessage

+ const GroupMessage

+ const Ping

+ const SystemMessage

+ func DynamicOrmTable(f func(string) string, baseTable, fieldValue string) func(db *gorm.DB) *gorm.DB

+ func GetDynamicOrmTable(f func(string) string, baseTable, fieldValue string) string

+ func Hash16(src string) string

+ func Hash32(src string) string

+ func Hash8(src string) string

+ func SetWatchConfigFunc(f config_drive.CallFunc)

+ func WatchConfigFunc(f config_drive.CallFunc)

+ type BroadCastMessageData struct

+ Message *MessageData

+ type Client struct

+ CancelFunc context.CancelFunc

+ Context context.Context

+ Group string

+ Id string

+ Message chan *MessageData

+ Socket *websocket.Conn

+ func (c *Client) Read(cxt context.Context)

+ func (c *Client) Write(cxt context.Context)

+ type ClientInfo struct

+ Group string

+ Id string

type Context

+ func (c *Context) Orm(name string) *gorm.DB

type CustomError

+ TraceID string

+ type GroupMessageData struct

+ Group string

+ Message *MessageData

type List

+ TraceID string

type ListData

+ TraceID string

+ type MessageData struct

+ From ClientInfo

+ ID string

+ Message string

+ To ClientInfo

+ Type string

+ func (m *MessageData) Bytes() []byte

type Response

+ TraceID string

v0.0.19

Mar 3, 2023

v0.0.18

Jan 28, 2023

v0.0.17

Jan 4, 2023

v0.0.16

Dec 25, 2022

v0.0.15

Dec 3, 2022

v0.0.14

Nov 27, 2022

v0.0.13

Nov 22, 2022

Changes in this version

+ var NewDB = true

v0.0.12

Nov 12, 2022

v0.0.11

Nov 12, 2022

Changes in this version

+ func WithTraceID(id string) option

+ type Option struct

+ TraceID string

+ func (u *Option) Option(opts ...option)

v0.0.10

Nov 6, 2022

Changes in this version

+ func ResponseJson(ctx *Context, data any)

+ func ResponseXml(ctx *Context, data any)

type Context

+ func (c *Context) RespJson(data interface{})

+ func (c *Context) RespXml(data interface{})

v0.0.9

Oct 20, 2022

v0.0.8

Oct 19, 2022

Changes in this version

+ func CustomResponseError(ctx *Context, code int, msg string)

v0.0.7

Oct 16, 2022

v0.0.4

Sep 28, 2022

Changes in this version

type ExtRsaConfig

+ Path string

v0.0.3

Sep 18, 2022

Changes in this version

type Context

+ func (c *Context) Http() *request

type HandlerFunc

+ func ExtRequestTokenAuth() HandlerFunc

v0.0.2

Sep 3, 2022

Changes in this version

+ const GetConfigTip

+ const SetConfigTip

+ var DisableForeignKey = false

+ var DryRun = false

+ var PrepareStmt = false

+ var ServiceID = "service"

+ var SingularTable = true

+ var SkipDefaultTransaction = true

+ var TraceID = "trace-id"

+ func ExtRecovery(c *Context)

+ func GormWhere(db *gorm.DB, tb string, src interface{}) *gorm.DB

+ func ResponseData(ctx *Context, data interface{})

+ func ResponseError(ctx *Context, err error)

+ func ResponseList(ctx *Context, page, count, total int, data interface{})

+ func ToSqlMap(tb string, src interface{}) map[string]interface

+ func WatchConfig(f config_drive.CallFunc)

+ type BaseModel struct

+ CreatedAt int64

+ ID int64

+ UpdatedAt int64

+ type Config struct

+ func (c *Config) Get(key string) interface{}

+ func (c *Config) GetBool(key string) bool

+ func (c *Config) GetDefaultDuration(key string, duration time.Duration) time.Duration

+ func (c *Config) GetDefaultFloat64(key string, def float64) float64

+ func (c *Config) GetDefaultInt(key string, def int) int

+ func (c *Config) GetDefaultString(key string, def string) string

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

+ func (c *Config) GetFloat64(key string) float64

+ func (c *Config) GetInt(key string) int

+ func (c *Config) GetInt32(key string) int32

+ func (c *Config) GetInt64(key string) int64

+ func (c *Config) GetIntSlice(key string) []int

+ func (c *Config) GetString(key string) string

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

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

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

+ func (c *Config) GetStringSlice(key string) []string

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

+ func (c *Config) GetUint(key string) uint

+ func (c *Config) GetUint32(key string) uint32

+ func (c *Config) GetUint64(key string) uint64

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

+ func (c *Config) Unmarshal(val interface{}) error

+ func (c *Config) UnmarshalKey(key string, val interface{}) error

type Context

+ ServiceName string

+ func NewContext() *Context

+ func (c *Context) Context() context.Context

+ func (c *Context) Mongo(name string) *mongo.Client

+ func (c *Context) Mysql(name string) *gorm.DB

+ func (c *Context) Rbac() *casbin.Enforcer

+ func (c *Context) Redis(name string) *redis.Client

+ func (c *Context) RespData(data interface{})

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

+ func (c *Context) RespList(page, count, total int, data interface{})

+ func (c *Context) RespSuccess()

+ func (c *Context) Rsa(name string) *ExtRsa

+ type CreateModel struct

+ CreatedAt int64

+ ID int64

+ type CustomError struct

+ Code int

+ Msg string

+ func (c *CustomError) Error() string

+ type DeleteModel struct

+ CreatedAt int64

+ DeletedAt gorm.DeletedAt

+ ID int64

+ UpdatedAt int64

+ type ExtRbacConfig struct

+ DB string

+ Enable bool

+ type ExtRsa struct

+ func (e ExtRsa) Decode(cipherText string) (string, error)

+ func (e ExtRsa) Encode(plainText string) (string, error)

+ type ExtRsaConfig struct

+ CertFile string

+ Enable bool

+ Name string

type HandlerFunc

+ func ExtCors() HandlerFunc

+ func ExtCpuLoad() HandlerFunc

+ func ExtInit() HandlerFunc

+ func ExtLimit() HandlerFunc

+ func ExtLogger() HandlerFunc

+ func ExtRequestInfo() HandlerFunc

+ func ExtTimeout() HandlerFunc

+ func Resp404() HandlerFunc

+ func Success() HandlerFunc

+ type IConfig interface

+ Get func(key string) interface{}

+ GetBool func(key string) bool

+ GetDefaultDuration func(key string, def time.Duration) time.Duration

+ GetDefaultInt func(key string, def int) int

+ GetDefaultString func(key string, def string) string

+ GetDuration func(key string) time.Duration

+ GetFloat64 func(key string) float64

+ GetInt func(key string) int

+ GetInt32 func(key string) int32

+ GetInt64 func(key string) int64

+ GetIntSlice func(key string) []int

+ GetString func(key string) string

+ GetStringMap func(key string) map[string]interface{}

+ GetStringMapString func(key string) map[string]string

+ GetStringMapStringSlice func(key string) map[string][]string

+ GetStringSlice func(key string) []string

+ GetTime func(key string) time.Time

+ GetUint func(key string) uint

+ GetUint32 func(key string) uint32

+ GetUint64 func(key string) uint64

+ Unmarshal func(val interface{}) error

+ UnmarshalKey func(key string, val interface{}) error

+ type List struct

+ Code int

+ Data ListData

+ Msg string

+ type ListData struct

+ Count int

+ List interface{}

+ Page int

+ Total int

+ type LogConfig struct

+ Level int8

+ ServiceKey string

+ TraceKey string

+ type RequestFunc func(*resty.Request) *resty.Request

+ type Response struct

+ Code int

+ Data interface{}

+ Msg string

+ func ParseResponse(data []byte) *Response

+ type ResponseWriterWrapper struct

+ Body *bytes.Buffer

+ func (w ResponseWriterWrapper) Write(b []byte) (int, error)

+ func (w ResponseWriterWrapper) WriteString(s string) (int, error)

v0.0.1

Jul 24, 2022

Changes in this version

+ const AuthUserKey

+ const BindKey

+ const BodyBytesKey

+ const ContextKey

+ const DebugMode

+ const EnvGinMode

+ const MIMEHTML

+ const MIMEJSON

+ const MIMEMultipartPOSTForm

+ const MIMEPOSTForm

+ const MIMEPlain

+ const MIMETOML

+ const MIMEXML

+ const MIMEXML2

+ const MIMEYAML

+ const PlatformCloudflare

+ const PlatformGoogleAppEngine

+ const ReleaseMode

+ const TestMode

+ const Version

+ 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

+ Config ext.IConfig

+ Errors errorMsgs

+ Keys map[string]any

+ Log *zap.Logger

+ Params Params

+ Request *http.Request

+ TraceID string

+ 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 any)

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

+ func (c *Context) AsciiJSON(code int, obj any)

+ func (c *Context) Bind(obj any) error

+ func (c *Context) BindHeader(obj any) error

+ func (c *Context) BindJSON(obj any) error

+ func (c *Context) BindQuery(obj any) error

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

+ func (c *Context) BindUri(obj any) error

+ func (c *Context) BindWith(obj any, b binding.Binding) error

+ func (c *Context) BindXML(obj any) error

+ func (c *Context) BindYAML(obj any) 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) DefaultPostForm(key, defaultValue string) string

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

+ 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) FullPath() string

+ func (c *Context) Get(key string) (value any, 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) GetPostForm(key string) (string, bool)

+ func (c *Context) GetPostFormArray(key string) (values []string, ok 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) (values []string, ok bool)

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

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

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

+ func (c *Context) GetStringMap(key string) (sm map[string]any)

+ 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 any)

+ 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 any)

+ func (c *Context) IsAborted() bool

+ func (c *Context) IsWebsocket() bool

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

+ func (c *Context) JSONP(code int, obj any)

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

+ func (c *Context) MustBindWith(obj any, b binding.Binding) error

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

+ 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) PostForm(key string) (value string)

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

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

+ func (c *Context) ProtoBuf(code int, obj any)

+ func (c *Context) PureJSON(code int, obj any)

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

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

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

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

+ func (c *Context) RemoteIP() string

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

+ func (c *Context) SSEvent(name string, message any)

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

+ func (c *Context) SecureJSON(code int, obj any)

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

+ 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) ShouldBind(obj any) error

+ func (c *Context) ShouldBindBodyWith(obj any, bb binding.BindingBody) (err error)

+ func (c *Context) ShouldBindHeader(obj any) error

+ func (c *Context) ShouldBindJSON(obj any) error

+ func (c *Context) ShouldBindQuery(obj any) error

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

+ func (c *Context) ShouldBindUri(obj any) error

+ func (c *Context) ShouldBindWith(obj any, b binding.Binding) error

+ func (c *Context) ShouldBindXML(obj any) error

+ func (c *Context) ShouldBindYAML(obj any) error

+ 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 ...any)

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

+ func (c *Context) Value(key any) any

+ func (c *Context) XML(code int, obj any)

+ func (c *Context) YAML(code int, obj any)

+ type Engine struct

+ AppEngine bool

+ ContextWithFallback bool

+ ForwardedByClientIP bool

+ FuncMap template.FuncMap

+ HTMLRender render.HTMLRender

+ HandleMethodNotAllowed bool

+ MaxMultipartMemory int64

+ RedirectFixedPath bool

+ RedirectTrailingSlash bool

+ RemoteIPHeaders []string

+ RemoveExtraSlash bool

+ TrustedPlatform string

+ UnescapePathValues bool

+ UseH2C 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) Handler() http.Handler

+ 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) SetTrustedProxies(trustedProxies []string) error

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

+ type Error struct

+ Err error

+ Meta any

+ Type ErrorType

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

+ func (msg *Error) JSON() any

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

+ func (msg *Error) SetMeta(data any) *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]any

+ 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 any) 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 IRouter interface

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

+ type IRoutes interface

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

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

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

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

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

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

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

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

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

+ Static func(string, string) IRoutes

+ StaticFS func(string, http.FileSystem) IRoutes

+ StaticFile func(string, string) IRoutes

+ StaticFileFS func(string, string, http.FileSystem) IRoutes

+ Use func(...HandlerFunc) IRoutes

+ type LogFormatter func(params LogFormatterParams) string

+ type LogFormatterParams struct

+ BodySize int

+ ClientIP string

+ ErrorMessage string

+ Keys map[string]any

+ 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 any

+ HTMLData any

+ HTMLName string

+ JSONData any

+ Offered []string

+ TOMLData any

+ XMLData any

+ YAMLData any

+ 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 any)

+ 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) IRoutes

+ func (group *RouterGroup) BasePath() string

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

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

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

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

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

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

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

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

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

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

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

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

+ func (group *RouterGroup) StaticFileFS(relativePath, filepath string, fs http.FileSystem) IRoutes

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

+ type RoutesInfo []RouteInfo

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