gin

package module

Go to main page

Versions in this module

v0

v0.1.5

Nov 26, 2025

Changes in this version

+ const Bool

+ const ClaimAud

+ const ClaimExp

+ const ClaimIat

+ const ClaimIss

+ const ClaimJti

+ const ClaimNbf

+ const ClaimScope

+ const ClaimSub

+ const ClaimType

+ const Date

+ const DateTime

+ const ErrCodeInvalidMethod

+ const ErrCodeInvalidPath

+ const ErrCodeMetadataInvalid

+ const ErrCodeMiddlewareTimeout

+ const ErrCodePatternInvalid

+ const ErrCodeRegistrationFail

+ const ErrCodeRouteConflict

+ const Float

+ const Int

+ const Int64

+ const String

+ const TokenTypeAccess

+ const TokenTypeRefresh

+ const UUID

+ func DefaultRateLimitKeyFunc(c *Context) string

+ func DevelopmentCSPConfig() string

+ func EndpointBasedRateLimitKeyFunc(c *Context) string

+ func ExtractParamNames(pattern string) ([]string, error)

+ func GenerateSecureJWTKey() (string, error)

+ func StrictCSPConfig() string

+ func UserBasedRateLimitKeyFunc(c *Context) string

+ func ValidateRoutePattern(method, pattern string) error

+ func ValidateSegmentName(name string) error

+ func WithFallback(handler gin.HandlerFunc) func(*ZipFSConfig)

+ func WithHotReload(interval time.Duration) func(*ZipFSConfig)

+ func WithIndexFile(filename string) func(*ZipFSConfig)

+ func WithPassword(password string) func(*ZipFSConfig)

+ func WithSubPaths(paths ...string) func(*ZipFSConfig)

+ type APIRoute struct

+ BasicAuth bool

+ BearerAuth bool

+ Deprecated bool

+ Description string

+ Handler HandlerFunc

+ Headers []*openapi3.ParameterRef

+ Hide bool

+ Metadata map[string]interface{}

+ Method string

+ OperationID string

+ Path string

+ PathParams []*openapi3.ParameterRef

+ QueryParams []*openapi3.ParameterRef

+ Request *openapi3.SchemaRef

+ RequestExample interface{}

+ ResponseHeaders map[string]*openapi3.HeaderRef

+ Responses map[int]*openapi3.SchemaRef

+ Security []map[string][]string

+ Summary string

+ Tags []string

+ type AuthInfo = types.AuthInfo

+ type Config struct

+ CacheConfig *cache.Config

+ CacheEnabled bool

+ ErrorHandlerEnabled bool

+ LoggerConfig *LoggerConfig

+ OpenAPI *OpenAPI

+ OpenAPIEnabled bool

+ SSEConfig *sse.Config

+ SSEEnabled bool

+ SecurityConfig *SecurityConfig

+ SensitiveFilter bool

+ func DefaultConfig() *Config

+ type Contact struct

+ Email string

+ Extensions map[string]any

+ Name string

+ URL string

+ func (c Contact) ToOpenAPI() *openapi3.Contact

type Context

+ func NewContext(c *gin.Context) *Context

+ func NewContextWithComponents(c *gin.Context, cache *cache.Cache[string, any], ...) *Context

+ func (c *Context) Accepted(msg string, url ...string)

+ func (c *Context) AuthInfo() (*types.AuthInfo, bool)

+ func (c *Context) BroadcastSSE(event *sse.Event)

+ func (c *Context) BuildURL(path string) *URLBuilder

+ func (c *Context) CSRFToken() string

+ func (c *Context) Clone() *Context

+ func (c *Context) ComponentsCount() int

+ func (c *Context) Created(data interface{}, url ...string)

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

+ func (c *Context) GenerateRequestID() string

+ func (c *Context) GenerateTokens(userClaims UserClaims, config ...*OAuthConfig) (*TokenResponse, error)

+ func (c *Context) GetGlobalCache() *cache.Cache[string, any]

+ func (c *Context) GetJWTPayload() JWTPayload

+ func (c *Context) HasAllRoles(roles ...string) bool

+ func (c *Context) HasAnyRole(roles ...string) bool

+ func (c *Context) HasComponents() bool

+ func (c *Context) HasRole(role string) bool

+ func (c *Context) IsJSON() bool

+ func (c *Context) IsPooled() bool

+ func (c *Context) IsSSL() bool

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

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

+ func (c *Context) NewSSEClientWithOptions(filters []string, opts ...sse.ClientOption) *sse.Client

+ func (c *Context) Next()

+ func (c *Context) NoContent()

+ func (c *Context) PaginateResponse(fetch func(page, size int) (interface{}, int64))

+ func (c *Context) Paginated(data interface{}, page, pageSize, total int64, url ...string)

+ func (c *Context) RefreshTokens(refreshToken string, config ...*OAuthConfig) (*TokenResponse, error)

+ func (c *Context) Reset()

+ func (c *Context) ServerError(msg ...string)

+ func (c *Context) SetCSRFToken() string

+ func (c *Context) SetCache(cache *cache.Cache[string, any])

+ func (c *Context) SetErrorHandler(handler types.ErrorHandler)

+ func (c *Context) SetJWTAdapter(adapter *JWTAdapter)

+ func (c *Context) SetJWTPayload(payload JWTPayload)

+ func (c *Context) SetSSEHub(hub *sse.Hub)

+ func (c *Context) ValidationError(errors interface{}, url ...string)

+ func (c *Context) WithComponents(cache *cache.Cache[string, any], errorHandler types.ErrorHandler, ...) *Context

+ type DefaultErrorHandler struct

+ SensitiveFilter bool

+ func (h *DefaultErrorHandler) HandleError(ctx types.RequestContext, err error)

+ type DefaultLogger struct

+ func NewDefaultLogger(prefix string) *DefaultLogger

+ func (l *DefaultLogger) Debug(format string, args ...any)

+ func (l *DefaultLogger) Error(format string, args ...any)

+ func (l *DefaultLogger) Info(format string, args ...any)

+ func (l *DefaultLogger) Warn(format string, args ...any)

+ type DocBuilder struct

+ func Doc() *DocBuilder

+ func (b *DocBuilder) AsOption() RouteOption

+ func (b *DocBuilder) BearerAuth() *DocBuilder

+ func (b *DocBuilder) Build() RouteOption

+ func (b *DocBuilder) Deprecated() *DocBuilder

+ func (b *DocBuilder) Description(description string) *DocBuilder

+ func (b *DocBuilder) ErrorResponse(status int, v any) *DocBuilder

+ func (b *DocBuilder) Header(name, typ, desc string, required bool) *DocBuilder

+ func (b *DocBuilder) Hide() *DocBuilder

+ func (b *DocBuilder) OperationID(operationID string) *DocBuilder

+ func (b *DocBuilder) PathParam(name, typ, desc string) *DocBuilder

+ func (b *DocBuilder) QueryParam(name, typ, desc string, required bool) *DocBuilder

+ func (b *DocBuilder) RequestBody(v any) *DocBuilder

+ func (b *DocBuilder) Response(statusOrValue any, vOptional ...any) *DocBuilder

+ func (b *DocBuilder) ResponseHeader(name, typ string, desc ...string) *DocBuilder

+ func (b *DocBuilder) Summary(summary string) *DocBuilder

+ func (b *DocBuilder) Tags(tags ...string) *DocBuilder

+ type DocOption interface

+ func Deprecated() DocOption

+ func Description(text string) DocOption

+ func PathParam(name, typ, description string) DocOption

+ func QueryParam(name, typ, description string, required bool) DocOption

+ func ReqBody[T any]() DocOption

+ func RequestBody(value interface{}) DocOption

+ func Resp[T any](status int) DocOption

+ func Response(statusOrValue interface{}, valueOptional ...interface{}) DocOption

+ func Security(scheme string, scopes ...string) DocOption

+ func Summary(text string) DocOption

+ func Tags(tags ...string) DocOption

+ type ErrorHandler = errors.ErrorHandler

+ type ExternalDocs struct

+ Description string

+ Extensions map[string]any

+ Origin *Origin

+ URL string

+ func (e *ExternalDocs) ToOpenAPI() *openapi3.ExternalDocs

+ type FileLogger struct

+ func NewFileLogger(prefix, filename string) (*FileLogger, error)

+ func (l *FileLogger) Close() error

+ type GinCompatLogger struct

+ func NewGinCompatLogger(prefix string) *GinCompatLogger

+ func (l *GinCompatLogger) Debug(format string, args ...any)

+ func (l *GinCompatLogger) Error(format string, args ...any)

+ func (l *GinCompatLogger) Info(format string, args ...any)

+ func (l *GinCompatLogger) Warn(format string, args ...any)

type Handler

+ Handlers func() map[string]HandlerFunc

type HandlerFunc

+ func CustomSecurityHeadersMiddleware(config SecurityHeadersConfig) HandlerFunc

+ func RateLimitMiddleware(config RateLimitConfig) HandlerFunc

+ func Route(method, path string, handler HandlerFunc) (string, HandlerFunc)

+ func SecurityHeadersMiddleware() HandlerFunc

+ type JWTAdapter struct

+ func (a *JWTAdapter) Close() error

+ func (a *JWTAdapter) GenerateToken(payload JWTPayload) (string, error)

+ func (a *JWTAdapter) IsTokenRevoked(jti string) bool

+ func (a *JWTAdapter) RevokeToken(jti string, exp time.Time) error

+ func (a *JWTAdapter) ValidateToken(tokenStr string) (JWTPayload, error)

+ func (a *JWTAdapter) WithTimeout(d time.Duration) *JWTAdapter

+ type JWTAuthRoutesConfig struct

+ AccessTokenTTL time.Duration

+ Authenticate func(*Context) (*types.AuthInfo, error)

+ BasePath string

+ PostLogin func(*Context, *types.AuthInfo, JWTTokens)

+ PostLogout func(*Context, *types.AuthInfo)

+ RefreshTokenTTL time.Duration

+ ResponseBuilder func(*Context, *types.AuthInfo, JWTTokens) interface{}

type JWTPayload

+ func (p JWTPayload) GetClaim(key string) (any, bool)

+ type JWTTokens struct

+ AccessToken string

+ RefreshToken string

+ type License struct

+ Extensions map[string]any

+ Name string

+ URL string

+ func (l License) ToOpenAPI() *openapi3.License

+ type Location struct

+ Column int

+ Line int

+ type Logger interface

+ Debug func(format string, args ...any)

+ Error func(format string, args ...any)

+ Info func(format string, args ...any)

+ Warn func(format string, args ...any)

+ type LoggerConfig struct

+ CustomLogger Logger

+ UseDefaultLogger bool

+ func DefaultLoggerConfig() *LoggerConfig

+ func (config *LoggerConfig) GetLogger(prefix string) Logger

+ type MemoryRateLimiter struct

+ func (rl *MemoryRateLimiter) Allow(key string) (bool, time.Time)

+ func (rl *MemoryRateLimiter) Reset(key string)

+ func (rl *MemoryRateLimiter) Stats(key string) (int, time.Time)

+ type NoOpLogger struct

+ func NewNoOpLogger() *NoOpLogger

+ func (l *NoOpLogger) Debug(format string, args ...any)

+ func (l *NoOpLogger) Error(format string, args ...any)

+ func (l *NoOpLogger) Info(format string, args ...any)

+ func (l *NoOpLogger) Warn(format string, args ...any)

+ type OAuthConfig struct

+ AccessTokenTTL time.Duration

+ DefaultScope string

+ Issuer string

+ RefreshTokenTTL time.Duration

+ func DefaultOAuthConfig() *OAuthConfig

+ type OAuthFlow struct

+ AuthorizationURL string

+ RefreshURL string

+ Scopes map[string]string

+ TokenURL string

+ func (f *OAuthFlow) ToOpenAPI() *openapi3.OAuthFlow

+ type OAuthFlows struct

+ AuthorizationCode *OAuthFlow

+ ClientCredentials *OAuthFlow

+ Implicit *OAuthFlow

+ Password *OAuthFlow

+ func (flows *OAuthFlows) ToOpenAPI() *openapi3.OAuthFlows

+ type OpenAPI struct

+ Contact Contact

+ ExternalDocs *ExternalDocs

+ License License

+ SecuritySchemes SecuritySchemes

+ Servers Servers

+ Title string

+ Version string

+ func (o OpenAPI) ToOpenAPISpec() *openapi3.T

+ type Origin struct

+ Fields map[string]Location

+ Key *Location

+ type PathValidationError struct

+ Path string

+ Suggestions []string

+ Violations []string

+ func NewPathValidationError(path string, violations []string, suggestions []string) *PathValidationError

+ type PatternSegment struct

+ IsParam bool

+ Name string

+ Position int

+ Type SegmentType

+ Value string

+ type Payload = JWTPayload

+ type RESTOption func(*restConfig)

+ func RESTWithBasePath(path string) RESTOption

+ func RESTWithDoc(action string, opts ...DocOption) RESTOption

+ func RESTWithDocsAll(opts ...DocOption) RESTOption

+ func RESTWithIDParam(name string) RESTOption

+ func RESTWithMiddleware(m ...HandlerFunc) RESTOption

+ func RESTWithRouteOptions(action string, options ...interface{}) RESTOption

+ type RateLimitConfig struct

+ KeyFunc func(*Context) string

+ RequestsPerWindow int

+ WindowSize time.Duration

+ type RateLimiter interface

+ Allow func(key string) (allowed bool, resetTime time.Time)

+ Reset func(key string)

+ Stats func(key string) (requests int, resetTime time.Time)

+ func NewRateLimiter(config RateLimitConfig) RateLimiter

+ type RefreshRequest struct

+ RefreshToken string

+ Scope string

+ type RouteError struct

+ Cause error

+ Code int

+ Details map[string]interface{}

+ Message string

+ Route string

+ Timestamp time.Time

+ Type string

+ func (re *RouteError) Error() string

+ func (re *RouteError) Unwrap() error

+ type RouteHandler struct

+ func NewRouteHandler(prefix string) *RouteHandler

+ func (r *RouteHandler) GetRouteHandler(method, path string) (HandlerFunc, bool)

+ func (r *RouteHandler) SetRouteHandler(method, path string, handlerFunc HandlerFunc)

+ type RouteOption func(*APIRoute)

+ func DocAutoPathParams() RouteOption

+ func DocBasicAuth() RouteOption

+ func DocBearerAuth() RouteOption

+ func DocDeprecated() RouteOption

+ func DocDescription(description string) RouteOption

+ func DocErrorResponse(status int, v any) RouteOption

+ func DocHeader(name, typ, desc string, required bool) RouteOption

+ func DocHide() RouteOption

+ func DocOperationID(operationID string) RouteOption

+ func DocPathParam(name, typ, desc string) RouteOption

+ func DocQueryParam(name, typ, desc string, required bool) RouteOption

+ func DocRequestBody(v any) RouteOption

+ func DocResponse(statusOrValue any, vOptional ...any) RouteOption

+ func DocResponseHeader(name, typ string, desc ...string) RouteOption

+ func DocSummary(summary string) RouteOption

+ func DocTag(tag string) RouteOption

+ func DocTags(tags ...string) RouteOption

+ type RoutePattern struct

+ CreateTime time.Time

+ Hash uint64

+ IsWildcard bool

+ Method string

+ ParamNames []string

+ Pattern string

+ Priority int

+ Segments []PatternSegment

+ func ParseRoutePattern(method, pattern string) (*RoutePattern, error)

+ func (rp *RoutePattern) Clone() *RoutePattern

+ func (rp *RoutePattern) Equals(other *RoutePattern) bool

+ func (rp *RoutePattern) GetParamNames() []string

+ func (rp *RoutePattern) GetParamSegmentCount() int

+ func (rp *RoutePattern) GetSegmentCount() int

+ func (rp *RoutePattern) GetStaticSegmentCount() int

+ func (rp *RoutePattern) HasParam(name string) bool

+ func (rp *RoutePattern) IsConflictWith(other *RoutePattern) bool

+ func (rp *RoutePattern) String() string

+ func (rp *RoutePattern) ToMap() map[string]interface{}

+ func (rp *RoutePattern) Validate() error

type Router

+ func NewRouterLegacy(engine *gin.Engine) *Router

+ func (r *Router) API(version string) *RouterGroup

+ func (r *Router) CRUD(resource string, handler ResourceHandler, opts ...RESTOption)

+ func (r *Router) Close() error

+ func (r *Router) EnableSwagger(paths ...string)

+ func (r *Router) GenerateOpenAPISpec() *openapi3.T

+ func (r *Router) GetErrorHandler() errors.ErrorHandler

+ func (r *Router) GetHandler() Handler

+ func (r *Router) GetJWTAdapter() *JWTAdapter

+ func (r *Router) GetRoutes() []string

+ func (r *Router) GetSSEHub() *sse.Hub

+ func (r *Router) GracefulShutdown(timeout time.Duration) error

+ func (r *Router) Health(path ...string)

+ func (r *Router) InvalidateOpenAPICache()

+ func (r *Router) IsRunning() bool

+ func (r *Router) JWTAuthRoutes(cfg JWTAuthRoutesConfig)

+ func (r *Router) JWTMiddleware() gin.HandlerFunc

+ func (r *Router) Metrics(path ...string)

+ func (r *Router) OAuth(basePath ...string)

+ func (r *Router) REST(resource string, handler ResourceHandler, opts ...RESTOption)

+ func (r *Router) RequireAnyRole(roles ...string) HandlerFunc

+ func (r *Router) RequireAuth(scopes ...string) HandlerFunc

+ func (r *Router) RequireRoles(roles ...string) HandlerFunc

+ func (r *Router) Restart() error

+ func (r *Router) RunWithContext(ctx context.Context, config ...ServerConfig) error

+ func (r *Router) RunWithContextString(ctx context.Context, addr string) error

+ func (r *Router) RunWithGracefulShutdown(config ServerConfig) error

+ func (r *Router) SetEmbed(urlPrefix string, embedFS embed.FS, subPaths ...string) error

+ func (r *Router) SetEmbedFile(urlPath string, embedFS embed.FS, filePath string) error

+ func (r *Router) SetZipFS(zipPath, urlPrefix string, options ...func(*ZipFSConfig)) error

+ func (r *Router) SetZipFSWithMiddleware(config ZipFSConfig, middlewares ...gin.HandlerFunc) error

+ func (r *Router) SetZipFile(urlPath, zipPath, filePath string, options ...ZipFileOption) error

+ func (r *Router) StartSSE() error

+ func (r *Router) StaticFiles(relativePath, root string, middleware ...HandlerFunc)

+ func (r *Router) Upload(path string, handler func(*Context, *multipart.FileHeader) error, ...)

+ func (r *Router) WithHandler(handler Handler) *Router

+ type RouterConfig struct

+ Host string

+ Port string

+ func DefaultRouterConfig() *RouterConfig

type RouterGroup

+ func (rg *RouterGroup) GetHandler() Handler

+ func (rg *RouterGroup) REST(resource string, handler ResourceHandler, opts ...RESTOption)

+ func (rg *RouterGroup) SetZipFS(zipPath string, options ...func(*ZipFSConfig)) error

+ func (rg *RouterGroup) SetZipFSWithMiddleware(zipPath string, middlewares []gin.HandlerFunc, options ...func(*ZipFSConfig)) error

+ func (rg *RouterGroup) SetZipFile(urlPath, zipPath, filePath string, options ...ZipFileOption) error

+ func (rg *RouterGroup) Use(middleware ...HandlerFunc)

+ func (rg *RouterGroup) UseGin(middleware ...gin.HandlerFunc)

+ func (rg *RouterGroup) WithMiddleware(middleware ...HandlerFunc) *RouterGroup

+ func (rg *RouterGroup) WithPrefix(prefix string) *RouterGroup

+ func (rg *RouterGroup) WithSecurity(scheme string, scopes ...string) *RouterGroup

+ func (rg *RouterGroup) WithTags(tags ...string) *RouterGroup

+ type RouterOption func(*Config, *gin.Engine)

+ func WithCORS(allowOrigins ...string) RouterOption

+ func WithCache(config *cache.Config) RouterOption

+ func WithConfig(customize func(*Config)) RouterOption

+ func WithGinMode(mode string) RouterOption

+ func WithJWT(secret string, customize ...func(*SecurityConfig)) RouterOption

+ func WithMiddleware(middlewares ...gin.HandlerFunc) RouterOption

+ func WithOpenAPI(config *OpenAPI) RouterOption

+ func WithRateLimit(requestsPerMinute int) RouterOption

+ func WithRateLimitEnhanced(requestsPerMinute int, keyFunc ...func(*Context) string) RouterOption

+ func WithRequestID() RouterOption

+ func WithSSE(config *sse.Config) RouterOption

+ func WithSecurityConfig(configure func(*SecurityConfig)) RouterOption

+ func WithSecurityHeaders(config ...SecurityHeadersConfig) RouterOption

+ func WithTimeout(timeout time.Duration) RouterOption

+ type SchemaInfo struct

+ Package string

+ Schema *openapi3.SchemaRef

+ TypeName string

+ type SecurityConfig struct

+ CORSAllowCredentials bool

+ CORSAllowedHeaders []string

+ CORSAllowedMethods []string

+ CORSAllowedOrigins []string

+ CORSMaxAge int

+ JWTAlgorithm string

+ JWTExpiration time.Duration

+ JWTRefreshEnabled bool

+ JWTSecretKey []byte

+ RateLimitEnabled bool

+ RateLimitRequestsPerMinute int

+ SecurityHeadersEnabled bool

+ func DefaultSecurityConfig() *SecurityConfig

+ func LoadSecurityConfig() (*SecurityConfig, error)

+ func (c *SecurityConfig) BuildJWTAdapter() (*JWTAdapter, error)

+ func (c *SecurityConfig) Validate() error

+ type SecurityHeadersConfig struct

+ ContentSecurityPolicy string

+ HideServerInfo bool

+ PermissionsPolicy string

+ ReferrerPolicy string

+ StrictTransportSecurity string

+ XContentTypeOptions bool

+ XFrameOptions string

+ XXSSProtection string

+ func DefaultSecurityHeadersConfig() SecurityHeadersConfig

+ type SecurityRequirement map[string][]string

+ type SecurityScheme struct

+ BearerFormat string

+ Description string

+ Flows *OAuthFlows

+ Name string

+ Scheme string

+ Type string

+ type SecuritySchemes []SecurityScheme

+ func (ss SecuritySchemes) ToOpenAPI() openapi3.SecuritySchemes

+ type SegmentType int

+ const SegmentTypeParam

+ const SegmentTypeStatic

+ const SegmentTypeWildcard

+ func IdentifySegmentType(segment string) (SegmentType, string, error)

+ func (st SegmentType) String() string

+ type Server struct

+ Description string

+ Extensions map[string]any

+ URL string

+ type Servers []Server

+ func (s Servers) ToOpenAPI() openapi3.Servers

+ type TokenResponse struct

+ AccessToken string

+ ExpiresIn int64

+ JTI string

+ RefreshToken string

+ Scope string

+ TokenType string

+ type URLBuilder struct

+ func (ub *URLBuilder) Build() string

+ func (ub *URLBuilder) Domain(domain string) *URLBuilder

+ func (ub *URLBuilder) Scheme(scheme string) *URLBuilder

+ func (ub *URLBuilder) Set(query string, value interface{}) *URLBuilder

+ type UserClaims struct

+ Email string

+ Roles []string

+ Scope string

+ UserID string

+ Username string

+ type ZipFSConfig struct

+ CheckInterval time.Duration

+ FallbackFS http.FileSystem

+ FallbackHandler gin.HandlerFunc

+ HotReload bool

+ IndexFile string

+ Password string

+ StripPrefix bool

+ SubPaths []string

+ URLPrefix string

+ ZipPath string

+ func NewZipFSConfig(zipPath, urlPrefix string, opts ...func(*ZipFSConfig)) ZipFSConfig

+ type ZipFSMetrics struct

+ ErrorCount int64

+ LastReload time.Time

+ ReloadCount int64

+ RequestCount int64

+ type ZipFile struct

+ func NewZipFile(zipPath, filePath string, config *ZipFileConfig) (*ZipFile, error)

+ func (zf *ZipFile) ServeHTTP(c *gin.Context)

+ func (zf *ZipFile) StartHotReload()

+ func (zf *ZipFile) Stop()

+ type ZipFileConfig struct

+ CheckInterval time.Duration

+ ContentType string

+ HotReload bool

+ Password string

+ type ZipFileOption func(*ZipFileConfig)

+ func WithContentType(contentType string) ZipFileOption

+ func WithFileHotReload(interval time.Duration) ZipFileOption

+ func WithFilePassword(password string) ZipFileOption

+ type ZipFileSystem struct

+ func NewZipFileSystem(config ZipFSConfig) (*ZipFileSystem, error)

+ func (zfs *ZipFileSystem) GetMetrics() ZipFSMetrics

+ func (zfs *ZipFileSystem) ServeHTTP(c *gin.Context)

+ func (zfs *ZipFileSystem) StartHotReload()

+ func (zfs *ZipFileSystem) Stop()

v0.1.4

Mar 24, 2025

Changes in this version

type JWTPayload

+ func (p JWTPayload) GetAudience() string

+ func (p JWTPayload) GetExpiresAt() time.Time

+ func (p JWTPayload) GetIssuedAt() time.Time

+ func (p JWTPayload) GetIssuer() string

+ func (p JWTPayload) GetJWTID() string

+ func (p JWTPayload) GetNotBefore() time.Time

+ func (p JWTPayload) GetSubject() string

type Router

+ func (r *Router) EnablePersistCache(persistPath string, autoPersistInterval time.Duration) error

+ func (r *Router) GetCache() *cache.Cache[string, any]

+ func (r *Router) SetCacheConfig(defaultExpiration, cleanupInterval time.Duration)

+ func (r *Router) SetGlobalCacheMiddleware(defaultExpiration, cleanupInterval time.Duration) HandlerFunc

+ func (r *Router) SetPersistCacheMiddleware(defaultExpiration, cleanupInterval time.Duration, persistPath string, ...) HandlerFunc

+ func (r *Router) WithCache(cache *cache.Cache[string, any]) HandlerFunc

v0.1.3

Mar 22, 2025

Changes in this version

type Cache

+ func (c *Cache[K, V]) Dec(key K, decrement any) (any, error)

+ func (c *Cache[K, V]) DecAtomic(key K, n int64) (int64, error)

+ func (c *Cache[K, V]) Inc(key K, increment any) (any, error)

+ func (c *Cache[K, V]) IncAtomic(key K, n int64) (int64, error)

v0.1.2

Mar 22, 2025

Changes in this version

+ type Cache struct

+ func NewCache[K comparable, V any](defaultExpiration, cleanupInterval time.Duration) *Cache[K, V]

+ func SetGlobalCache(defaultExpiration, cleanupInterval time.Duration) *Cache[string, any]

+ func SetGlobalCacheWithPersistence(defaultExpiration, cleanupInterval time.Duration, persistPath string, ...) *Cache[string, any]

+ func (c *Cache[K, V]) BLPop(key K, timeout time.Duration) (V, bool)

+ func (c *Cache[K, V]) BRPop(key K, timeout time.Duration) (V, bool)

+ func (c *Cache[K, V]) BRPopLPush(source K, destination K, timeout time.Duration) (V, bool)

+ func (c *Cache[K, V]) BeginTransaction() *Transaction[K, V]

+ func (c *Cache[K, V]) Clear()

+ func (c *Cache[K, V]) Close()

+ func (c *Cache[K, V]) Count() int

+ func (c *Cache[K, V]) Delete(key K)

+ func (c *Cache[K, V]) DeleteExpired()

+ func (c *Cache[K, V]) DeleteList(key K)

+ func (c *Cache[K, V]) DisableAutoPersist()

+ func (c *Cache[K, V]) EnableAutoPersist()

+ func (c *Cache[K, V]) Flush() error

+ func (c *Cache[K, V]) ForEach(fn func(key K, value V) bool)

+ func (c *Cache[K, V]) ForEachList(fn func(key K, list []V) bool)

+ func (c *Cache[K, V]) Get(key K) (V, bool)

+ func (c *Cache[K, V]) GetListTTL(key K) (time.Duration, bool)

+ func (c *Cache[K, V]) GetStats() Stats

+ func (c *Cache[K, V]) GetTTL(key K) (time.Duration, bool)

+ func (c *Cache[K, V]) GetWithTTL(key K) (V, time.Duration, bool)

+ func (c *Cache[K, V]) Has(key K) bool

+ func (c *Cache[K, V]) HasList(key K) bool

+ func (c *Cache[K, V]) Increment(key K, increment any) (any, error)

+ func (c *Cache[K, V]) Keys() []K

+ func (c *Cache[K, V]) LIndex(key K, index int) (V, bool)

+ func (c *Cache[K, V]) LInsert(key K, before bool, pivot V, value V, equals func(a, b V) bool) int

+ func (c *Cache[K, V]) LPop(key K) (V, bool)

+ func (c *Cache[K, V]) LPush(key K, values ...V) int

+ func (c *Cache[K, V]) LRange(key K, start, stop int) []V

+ func (c *Cache[K, V]) LRem(key K, count int, value V, equals func(a, b V) bool) int

+ func (c *Cache[K, V]) LSet(key K, index int, value V) bool

+ func (c *Cache[K, V]) LTrim(key K, start, stop int) bool

+ func (c *Cache[K, V]) ListCount() int

+ func (c *Cache[K, V]) ListKeys() []K

+ func (c *Cache[K, V]) Load() error

+ func (c *Cache[K, V]) LoadOrInit() error

+ func (c *Cache[K, V]) RPop(key K) (V, bool)

+ func (c *Cache[K, V]) RPoplPush(source K, destination K) (V, bool)

+ func (c *Cache[K, V]) RPush(key K, values ...V) int

+ func (c *Cache[K, V]) Save() error

+ func (c *Cache[K, V]) Set(key K, value V, duration ...time.Duration)

+ func (c *Cache[K, V]) SetList(key K, duration ...time.Duration)

+ func (c *Cache[K, V]) WithPersistence(persistPath string, autoPersistInterval time.Duration) *Cache[K, V]

type Context

+ func (c *Context) CacheClear()

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

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

+ func (c *Context) CacheGet(key string) (any, bool)

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

+ func (c *Context) CacheGetFloat64(key string) (float64, bool)

+ func (c *Context) CacheGetInt(key string) (int, bool)

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

+ func (c *Context) CacheHas(key string) bool

+ func (c *Context) CacheHasList(key string) bool

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

+ func (c *Context) CacheLIndex(key string, index int) (any, bool)

+ func (c *Context) CacheLPop(key string) (any, bool)

+ func (c *Context) CacheLPush(key string, values ...any) int

+ func (c *Context) CacheLRange(key string, start, stop int) []any

+ func (c *Context) CacheRPop(key string) (any, bool)

+ func (c *Context) CacheRPush(key string, values ...any) int

+ func (c *Context) CacheSet(key string, value any, duration ...time.Duration)

+ func (c *Context) CacheSetList(key string, duration ...time.Duration)

+ func (c *Context) GetCache() *Cache[string, any]

+ type Stats struct

+ CreationTime time.Time

+ DeletedCount uint64

+ ExpiredCount uint64

+ HitCount uint64

+ IsAutoPersist bool

+ ItemsCount int

+ LastLoadTime time.Time

+ LastSaveTime time.Time

+ ListsCount int

+ MemoryUsage uint64

+ MissCount uint64

+ PersistPath string

+ SaveInterval time.Duration

+ type Transaction struct

+ func (t *Transaction[K, V]) Commit()

+ func (t *Transaction[K, V]) Delete(key K)

+ func (t *Transaction[K, V]) DeleteList(key K)

+ func (t *Transaction[K, V]) LPush(key K, values ...V)

+ func (t *Transaction[K, V]) Rollback()

+ func (t *Transaction[K, V]) Set(key K, value V, duration time.Duration)

+ func (t *Transaction[K, V]) SetListExpiration(key K, duration time.Duration)

v0.1.1

Mar 22, 2025

Changes in this version

+ const JWTAlgHS256

+ const JWTAlgHS384

+ const JWTAlgHS512

+ const JWTClaimAud

+ const JWTClaimExp

+ const JWTClaimIat

+ const JWTClaimIss

+ const JWTClaimJti

+ const JWTClaimNbf

+ const JWTClaimSub

+ const JWTCookieKey

+ const JWTHeaderKey

+ const JWTPrefix

+ const JWTQueryKey

type BasicHandler

+ func NewBasicHandler() *BasicHandler

+ func (b *BasicHandler) Clone() Handler

type Context

+ func (c *Context) BindAndValidate(obj interface{}) bool

+ func (c *Context) BindForm(obj interface{}) bool

+ func (c *Context) BindHeader(obj interface{}) bool

+ func (c *Context) BindJSON(obj interface{}) bool

+ func (c *Context) BindQuery(obj interface{}) bool

+ func (c *Context) BindUri(obj interface{}) bool

+ func (c *Context) Cache(seconds int)

+ func (c *Context) ClearJWT()

+ func (c *Context) CreateJWTSession(secretKey string, userID string, expiration time.Duration, ...) (string, error)

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

+ func (c *Context) Dump() H

+ func (c *Context) GenerateJWT(secretKey string, payload JWTPayload) (string, error)

+ func (c *Context) GetIntSlice(key string, sep ...string) []int

+ func (c *Context) GetJWT() string

+ func (c *Context) GetStringSlice(key string, sep ...string) []string

+ func (c *Context) HTML(html string)

+ func (c *Context) Language() string

+ func (c *Context) MethodNotAllowed()

+ func (c *Context) NewSSEClient(hub *SSEHub, filters ...string) *_SSEClient

+ func (c *Context) NoCache()

+ func (c *Context) Paginate(defaultPageSize ...int) (page, pageSize int)

+ func (c *Context) ParamInt(param string, defaultValue ...int) int

+ func (c *Context) ParseJWTPayload(token string) (JWTPayload, error)

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

+ func (c *Context) RefreshJWTSession(secretKey string, expiration time.Duration) (string, error)

+ func (c *Context) RequestInfo() H

+ func (c *Context) RequireJWT(secretKey string) (JWTPayload, bool)

+ func (c *Context) ServiceUnavailable(msg string)

+ func (c *Context) SessionGet(key string) (interface{}, bool)

+ func (c *Context) SessionGetBool(key string) bool

+ func (c *Context) SessionGetInt(key string) int

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

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

+ func (c *Context) SetCSP(policy string)

+ func (c *Context) SetJWT(token string, maxAge int)

+ func (c *Context) SetSecureHeaders()

+ func (c *Context) SetXFrameOptions(option string)

+ func (c *Context) SetXSSProtection()

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

+ func (c *Context) Unauthorized(msg string)

+ func (c *Context) Validate(v Validator) bool

+ func (c *Context) ValidateJWT(secretKey string, token string) (JWTPayload, error)

+ func (c *Context) ValidateWithCode(v Validator, code int) bool

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

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

type Handler

+ SetHandler func(action string, handlerFunc HandlerFunc)

+ type HandlerWrapper struct

+ Cache map[string]HandlerFunc

+ Handler Handler

+ Middlewares []HandlerFunc

+ func NewHandlerWrapper(handler Handler) *HandlerWrapper

+ func (hw *HandlerWrapper) Clone() Handler

+ func (hw *HandlerWrapper) GetHandler(action string) (HandlerFunc, bool)

+ func (hw *HandlerWrapper) SetHandler(action string, handlerFunc HandlerFunc)

+ func (hw *HandlerWrapper) UseMiddleware(middlewares ...HandlerFunc)

+ type JWTPayload map[string]interface

+ func (p JWTPayload) SetAudience(audience string) JWTPayload

+ func (p JWTPayload) SetExpiresAt(expiresAt time.Time) JWTPayload

+ func (p JWTPayload) SetIssuedAt(issuedAt time.Time) JWTPayload

+ func (p JWTPayload) SetIssuer(issuer string) JWTPayload

+ func (p JWTPayload) SetJWTID(jwtID string) JWTPayload

+ func (p JWTPayload) SetNotBefore(notBefore time.Time) JWTPayload

+ func (p JWTPayload) SetSubject(subject string) JWTPayload

+ type ListResponse struct

+ Data any

+ Pagination Pagination

+ type Pagination struct

+ CurrentPage int

+ PageSize int

+ TotalCount int64

+ TotalPages int

+ type ResourceHandler interface

+ Create func(*Context)

+ Delete func(*Context)

+ Index func(*Context)

+ Show func(*Context)

+ Update func(*Context)

+ type RestfulHandler struct

+ func (h *RestfulHandler) Create(c *Context)

+ func (h *RestfulHandler) Delete(c *Context)

+ func (h *RestfulHandler) Index(c *Context)

+ func (h *RestfulHandler) Show(c *Context)

+ func (h *RestfulHandler) Update(c *Context)

+ type Router struct

+ func (r *Router) ANY(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (r *Router) CONNECT(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (r *Router) DELETE(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (r *Router) Engine() *gin.Engine

+ func (r *Router) GET(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (r *Router) Group(path string, middleware ...HandlerFunc) *RouterGroup

+ func (r *Router) HEAD(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (r *Router) NewSSEHub(size ...int) *SSEHub

+ func (r *Router) OPTIONS(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (r *Router) PATCH(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (r *Router) POST(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (r *Router) PUT(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (r *Router) Register(method, path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (r *Router) Resource(path string, handler ResourceHandler, middleware ...HandlerFunc)

+ func (r *Router) Run(addr ...string) error

+ func (r *Router) RunTLS(addr, certFile, keyFile string) error

+ func (r *Router) RunWithConfig(config ServerConfig) error

+ func (r *Router) TRACE(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (r *Router) Use(middleware ...HandlerFunc)

+ func (r *Router) UseGin(middleware ...gin.HandlerFunc)

+ type RouterGroup struct

+ func (rg *RouterGroup) ANY(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (rg *RouterGroup) CONNECT(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (rg *RouterGroup) DELETE(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (rg *RouterGroup) GET(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (rg *RouterGroup) Group(path string, middleware ...HandlerFunc) *RouterGroup

+ func (rg *RouterGroup) HEAD(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (rg *RouterGroup) OPTIONS(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (rg *RouterGroup) PATCH(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (rg *RouterGroup) POST(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (rg *RouterGroup) PUT(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (rg *RouterGroup) Register(method, path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (rg *RouterGroup) Resource(path string, handler ResourceHandler, middleware ...HandlerFunc)

+ func (rg *RouterGroup) TRACE(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ type SSEEvent struct

+ Data any

+ Event string

+ ID string

+ Retry int

+ type SSEHub struct

+ func (h *SSEHub) BroadCast(event *SSEEvent)

+ func (h *SSEHub) Close()

+ func (h *SSEHub) GetClients() []string

+ func (h *SSEHub) IsRunning() bool

+ func (h *SSEHub) Restart()

+ func (h *SSEHub) Run()

+ func (h *SSEHub) SendToClient(clientID string, event *SSEEvent) bool

+ type ServerConfig struct

+ CertFile string

+ EnableHTTP2 bool

+ GracefulTimeout time.Duration

+ Host string

+ KeyFile string

+ MaxHeaderBytes int

+ Port string

+ ReadTimeout time.Duration

+ WriteTimeout time.Duration

+ func DefaultServerConfig() ServerConfig

+ type Validator interface

+ Validate func() (bool, string)

v0.1.0

Dec 20, 2024

Changes in this version

+ const DebugMode

+ const EnvGinMode

+ const ErrorCode

+ const FailCode

+ const ForbiddenCode

+ const MethodAny

+ const MethodConnect

+ const MethodDelete

+ const MethodGet

+ const MethodHead

+ const MethodOptions

+ const MethodPatch

+ const MethodPost

+ const MethodPut

+ const MethodTrace

+ const NotFound

+ const ReleaseMode

+ const SuccessCode

+ const TestMode

+ func Default() *gin.Engine

+ func DisableBindValidation()

+ func EnableJsonDecoderDisallowUnknownFields()

+ func EnableJsonDecoderUseNumber()

+ func InitRouting(engine *gin.Engine) *gin.Engine

+ func New() *gin.Engine

+ func NewRouter(e *gin.Engine) *_Router

+ func Register(method, path string, handlers ...HandlerFunc) error

+ func SetMode(value string)

+ func WrapHandler(hd HandlerFunc) gin.HandlerFunc

+ type BasicHandler struct

+ Handlers map[string]HandlerFunc

+ func (b *BasicHandler) GetHandler(action string) HandlerFunc

+ func (b *BasicHandler) SetHandler(action string, handlerFunc HandlerFunc)

+ type Context struct

+ func (c *Context) AllowCORS()

+ func (c *Context) BaseFile() string

+ func (c *Context) BaseURL() string

+ func (c *Context) BuildUrl(path string, params H) *urlBuilder

+ func (c *Context) ContentType() string

+ func (c *Context) Domain() string

+ func (c *Context) Error(msg string, url ...string)

+ func (c *Context) Ext() string

+ func (c *Context) Fail(msg string, url ...string)

+ func (c *Context) FailWithData(msg string, data interface{}, url ...string)

+ func (c *Context) Forbidden(msg string, url ...string)

+ func (c *Context) GetIP() string

+ func (c *Context) GetToken(name ...string) string

+ func (c *Context) GetUserAgent() string

+ func (c *Context) Host() string

+ func (c *Context) IsAjax() bool

+ func (c *Context) IsConnect() bool

+ func (c *Context) IsDelete() bool

+ func (c *Context) IsGet() bool

+ func (c *Context) IsHead() bool

+ func (c *Context) IsJson() bool

+ func (c *Context) IsOptions() bool

+ func (c *Context) IsPatch() bool

+ func (c *Context) IsPjax() bool

+ func (c *Context) IsPost() bool

+ func (c *Context) IsPut() bool

+ func (c *Context) IsSsl() bool

+ func (c *Context) IsTrace() bool

+ func (c *Context) Method() string

+ func (c *Context) NotFound(msg string, url ...string)

+ func (c *Context) PageResponse(list interface{}, total int64, page, pageSize int)

+ func (c *Context) PanDomain() string

+ func (c *Context) Param(param string, defaultValue ...string) string

+ func (c *Context) Port() string

+ func (c *Context) Protocol() string

+ func (c *Context) Redirect(location string)

+ func (c *Context) RedirectPermanent(location string)

+ func (c *Context) RemotePort() string

+ func (c *Context) RequireParams(params ...string) bool

+ func (c *Context) Response(httpStatus, code int, msg string, data interface{}, url ...string)

+ func (c *Context) Root() string

+ func (c *Context) RootDomain() string

+ func (c *Context) RootUrl() string

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

+ func (c *Context) Scheme() string

+ func (c *Context) SubDomain() string

+ func (c *Context) Success(data interface{}, url ...string)

+ func (c *Context) SuccessWithMsg(msg string, data interface{}, url ...string)

+ func (c *Context) Time() time.Time

+ func (c *Context) Type() string

+ func (c *Context) URL() string

+ func (c *Context) ValidateFile(file *multipart.FileHeader, config UploadConfig) error

+ type Controller struct

+ func (c *Controller) CONNECT(relativePath, action string) *Controller

+ func (c *Controller) DELETE(relativePath, action string) *Controller

+ func (c *Controller) GET(relativePath, action string) *Controller

+ func (c *Controller) Group(relativePath, action string) *Controller

+ func (c *Controller) HEAD(relativePath, action string) *Controller

+ func (c *Controller) OPTIONS(relativePath, action string) *Controller

+ func (c *Controller) PATCH(relativePath, action string) *Controller

+ func (c *Controller) POST(relativePath, action string) *Controller

+ func (c *Controller) PUT(relativePath, action string) *Controller

+ func (c *Controller) Resource(relativePath string) *Controller

+ func (c *Controller) TRACE(relativePath, action string) *Controller

+ func (c *Controller) Use(action string) *Controller

+ type H map[string]any

+ type Handler interface

+ Clone func() Handler

+ GetHandler func(action string) HandlerFunc

+ type HandlerFunc func(c *Context)

+ type UploadConfig struct

+ AllowedExts []string

+ MaxSize int64

+ SavePath string

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