cygin

package

Go to main page

Versions in this module

v1

v1.0.0

Aug 21, 2026

Changes in this version

+ const ErrBadRequest

+ const ErrDatabaseOperation

+ const ErrForbidden

+ const ErrInternalServer

+ const ErrNotFound

+ const ErrParamsInvalid

+ const ErrTimeout

+ const ErrUnauthorized

+ var SkipAutoPrivPaths sync.Map

+ func CompressionLevel(level int) string

+ func Gzip() gin.HandlerFunc

+ func ResponseError(c *gin.Context, err error)

+ func SecurityHeaders() gin.HandlerFunc

+ func ServeWithOption(urlPrefix string, fs ServeFileSystem, options *ServeOptions) gin.HandlerFunc

+ func StaticCache(maxAge int) gin.HandlerFunc

+ func StaticCacheByPath(indexMaxAge, staticMaxAge int) gin.HandlerFunc

+ func StaticCacheWithETag(maxAge int, enableETag bool) gin.HandlerFunc

type ApiEndpoint

+ SkipAutoPrivilege bool

type ApiGroup

+ IgnoreBasePath bool

+ type CacheableFileSystem interface

+ ClearCache func()

+ GetCacheCount func() int

type EmbeddedFileConfig

+ Middlewares []gin.HandlerFunc

+ type EmbeddedFileOption func(*EmbeddedFileConfig)

+ func WithEmbeddedMiddlewares(middlewares ...gin.HandlerFunc) EmbeddedFileOption

+ type EmbeddedFileService struct

+ FS embed.FS

+ Root string

+ func NewEmbeddedFileService(urlPath string, filesystem embed.FS, root string, ...) *EmbeddedFileService

+ func (efs *EmbeddedFileService) Exists(path string) (string, bool)

+ func (efs *EmbeddedFileService) GetMiddlewares() []gin.HandlerFunc

+ func (efs *EmbeddedFileService) GetURLPath() string

+ func (efs *EmbeddedFileService) Match(path string) bool

+ func (efs *EmbeddedFileService) Serve(c *gin.Context)

type EndpointBuilder

+ func (b *EndpointBuilder) ANY(path string, handler interface{}, options ...EndpointOption) APIHandler

type Error

+ Silent bool

+ type ErrorCfg struct

+ Details []string

+ PrintLog bool

+ Silent bool

+ Status int

+ type ErrorOption func(cfg *ErrorCfg)

+ func WithErrDetailf(format string, a ...any) ErrorOption

+ func WithErrDetails(details ...string) ErrorOption

+ func WithErrPrint() ErrorOption

+ func WithErrSilent(silent bool) ErrorOption

+ func WithStatus(status int) ErrorOption

+ type FileService interface

+ Exists func(path string) (actualPath string, exists bool)

+ GetMiddlewares func() []gin.HandlerFunc

+ GetURLPath func() string

+ Match func(path string) bool

+ Serve func(c *gin.Context)

+ type FileServiceConfig struct

+ Middlewares []gin.HandlerFunc

+ URLPath string

+ type ObjectStoreCacheOption func(*objectStoreFileSystem)

+ func WithCacheTTL(ttl time.Duration) ObjectStoreCacheOption

+ func WithDebug(enabled bool) ObjectStoreCacheOption

+ func WithMaxCacheSize(maxSize int64) ObjectStoreCacheOption

+ type ObjectStoreFileConfig struct

+ Bucket string

+ Middlewares []gin.HandlerFunc

+ RootPrefix string

+ Store *cystore.Store

+ UrlPath string

+ type ObjectStoreFileOption func(*ObjectStoreFileConfig)

+ func WithObjectStoreMiddlewares(middlewares ...gin.HandlerFunc) ObjectStoreFileOption

+ type ObjectStoreFileService struct

+ Bucket string

+ RootPrefix string

+ Store *cystore.Store

+ func NewObjectStoreFileService(urlPath string, store *cystore.Store, bucket string, rootPrefix string, ...) *ObjectStoreFileService

+ func (ofs *ObjectStoreFileService) Exists(path string) (string, bool)

+ func (ofs *ObjectStoreFileService) GetMiddlewares() []gin.HandlerFunc

+ func (ofs *ObjectStoreFileService) GetURLPath() string

+ func (ofs *ObjectStoreFileService) Match(path string) bool

+ func (ofs *ObjectStoreFileService) Serve(c *gin.Context)

+ type PageInfo struct

+ Page int

+ Size int

+ TotalCount int64

+ type PageResult struct

+ Data any

+ Page *PageInfo

+ type PaginatedResult = cydb.PaginatedResult[T]

type Rsp

+ CostTime string

+ Debug any

+ HttpStatus *int

+ Silent *bool

+ Success bool

type ServeFileSystem

+ func ObjectStoreFile(store *cystore.Store, bucket, rootPrefix string, ...) ServeFileSystem

+ type ServeMode int

+ const ServeModeCheckOnly

+ const ServeModeDefault

+ type ServeOptions struct

+ Mode ServeMode

+ PathFilter func(path string) bool

type Server

+ func NewServerWithCtx(ctx context.Context, opts ...ServerOption) *Server

type ServerOption

+ func WithGlobalMiddlewares(middlewares ...gin.HandlerFunc) ServerOption

+ func WithObjectStoreFiles(urlPath string, store *cystore.Store, bucket, rootPrefix string, ...) ServerOption

type StaticFileConfig

+ Middlewares []gin.HandlerFunc

+ type StaticFileOption func(*StaticFileConfig)

+ func WithStaticMiddlewares(middlewares ...gin.HandlerFunc) StaticFileOption

+ type StaticFileService struct

+ DirPath string

+ func NewStaticFileService(urlPath string, dirPath string, middlewares ...gin.HandlerFunc) *StaticFileService

+ func (sfs *StaticFileService) Exists(path string) (string, bool)

+ func (sfs *StaticFileService) GetMiddlewares() []gin.HandlerFunc

+ func (sfs *StaticFileService) GetURLPath() string

+ func (sfs *StaticFileService) Match(path string) bool

+ func (sfs *StaticFileService) Serve(c *gin.Context)

+ type UnifiedFileServer struct

+ func NewUnifiedFileServer() *UnifiedFileServer

+ func (ufs *UnifiedFileServer) AddPathPrefix(prefix string)

+ func (ufs *UnifiedFileServer) AddService(service FileService)

+ func (ufs *UnifiedFileServer) GetServiceByURL(urlPath string) FileService

+ func (ufs *UnifiedFileServer) GetServices() []FileService

+ func (ufs *UnifiedFileServer) Middleware() gin.HandlerFunc

v0

v0.0.1

Sep 23, 2025

Changes in this version

+ const ErrCodeInternal

+ const ErrCodeInvalidParam

+ const ErrCodeNotFound

+ const INDEX

+ const LangEN

+ const LangZH

+ var BuildTime = "unknown"

+ var BuildVersion = "dev"

+ func BindAll(c *gin.Context, obj any, bindType BindType) error

+ func BindAndValidate(c *gin.Context, obj interface{}) error

+ func BindJSONAndValidate(c *gin.Context, obj interface{}) error

+ func BindQueryAndValidate(c *gin.Context, obj interface{}) error

+ func FromCtx(c *gin.Context) string

+ func GetValidator() *validator.Validate

+ func HandleAny(fn any, cb ...cbZeroIO) (gin.HandlerFunc, error)

+ func HandleNoResp[Req any](fn func(c *gin.Context, req Req, cb ...cbZeroIO) error) gin.HandlerFunc

+ func Handle[Req any, Rsp any](fn func(c *gin.Context, req Req) (Rsp, error), cb ...cbZeroIO) gin.HandlerFunc

+ func LocalFile(root string, indexes bool) *localFileSystem

+ func RegErrMsg(code int, fn func(lang string) string)

+ func RegErrMsgStatic(code int, kvs ...string)

+ func RegisterMessages(msgs map[int]map[string]string)

+ func Serve(urlPrefix string, fs ServeFileSystem, isGroupPath ...funcIsGroupPath) gin.HandlerFunc

+ func ServeRoot(urlPrefix, root string) gin.HandlerFunc

+ func SetDefaultSuccessCode(code int)

+ func SetupValidator()

+ func ValidateStruct(obj any) error

+ func ValidateStructWithLang(obj any, lang string) error

+ type APIHandler interface

+ RegistRouter func(basePath string, g *gin.RouterGroup) *RegistResult

+ type ApiEndpoint struct

+ Description string

+ Handler any

+ Method ApiMethod

+ Middleware []gin.HandlerFunc

+ Path string

+ Summary string

+ Tags []string

+ func (ae *ApiEndpoint) RegistRouter(basePath string, g *gin.RouterGroup) *RegistResult

+ type ApiGroup struct

+ APIHandler []APIHandler

+ BasePath string

+ Description string

+ Middleware []gin.HandlerFunc

+ Tags []string

+ func (ag *ApiGroup) RegistRouter(basePath string, g *gin.RouterGroup) *RegistResult

+ type ApiMethod string

+ const Any

+ const Delete

+ const Get

+ const Head

+ const Options

+ const Patch

+ const Post

+ const Put

+ type BindType = int

+ const BindTypeAll

+ const BindTypeFile

+ const BindTypeForm

+ const BindTypeHeader

+ const BindTypeJson

+ const BindTypeNone

+ const BindTypeQuery

+ const BindTypeUri

+ type Config struct

+ Address string

+ AutoRegister bool

+ Description string

+ EnablePprof bool

+ EnableSwagger bool

+ Env string

+ Title string

+ Version string

+ type EmbeddedFileConfig struct

+ FS embed.FS

+ Root string

+ UrlPath string

+ type Endpoint struct

+ func (e Endpoint) Build() ApiEndpoint

+ func (e Endpoint) WithDescription(description string) Endpoint

+ func (e Endpoint) WithSummary(summary string) Endpoint

+ func (e Endpoint) WithTags(tags ...string) Endpoint

+ type EndpointBuilder struct

+ func NewEndpointBuilder(basePath string, description string, tags []string) *EndpointBuilder

+ func (b *EndpointBuilder) Build(apiHandlers ...APIHandler) ApiGroup

+ func (b *EndpointBuilder) DELETE(path string, handler interface{}, options ...EndpointOption) APIHandler

+ func (b *EndpointBuilder) GET(path string, handler interface{}, options ...EndpointOption) APIHandler

+ func (b *EndpointBuilder) GROUP(path string, handlers []APIHandler, options ...GroupOption) APIHandler

+ func (b *EndpointBuilder) HEAD(path string, handler interface{}, options ...EndpointOption) APIHandler

+ func (b *EndpointBuilder) OPTIONS(path string, handler interface{}, options ...EndpointOption) APIHandler

+ func (b *EndpointBuilder) PATCH(path string, handler interface{}, options ...EndpointOption) APIHandler

+ func (b *EndpointBuilder) POST(path string, handler interface{}, options ...EndpointOption) APIHandler

+ func (b *EndpointBuilder) PUT(path string, handler interface{}, options ...EndpointOption) APIHandler

+ type EndpointOption func(*ApiEndpoint)

+ func WithDescription(description string) EndpointOption

+ func WithMiddleware(middleware ...gin.HandlerFunc) EndpointOption

+ func WithSummary(summary string) EndpointOption

+ func WithTags(tags ...string) EndpointOption

+ type Error struct

+ Code int

+ Details []string

+ Status int

+ func NewError(code int, status ...int) *Error

+ func WrapError(err error, code int, status ...int) *Error

+ func (e *Error) Error() string

+ func (e *Error) Log() *Error

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

+ func (e *Error) Msg(lang string) string

+ func (e *Error) Response(lang string) any

+ func (e *Error) WithDetail(details string) *Error

+ func (e *Error) WithDetailf(format string, a ...any) *Error

+ type GroupOption func(*ApiGroup)

+ func WithGroupDescription(description string) GroupOption

+ func WithGroupMiddleware(middleware ...gin.HandlerFunc) GroupOption

+ func WithGroupTags(tags ...string) GroupOption

+ type PageData struct

+ Data any

+ Page int

+ Size int

+ Total int

+ type RegistResult struct

+ func (r *RegistResult) Merge(other *RegistResult) *RegistResult

+ type RouterGroup interface

+ Group func() ApiGroup

+ type Rsp struct

+ Code int

+ Data any

+ Msg string

+ Page *int

+ Size *int

+ Total *int

+ type ServeFileSystem interface

+ Exists func(prefix string, path string) bool

+ func EmbedFolder(fsEmbed embed.FS, targetPath string) ServeFileSystem

+ type Server struct

+ ApiGroups []ApiGroup

+ Config *Config

+ Engine *gin.Engine

+ PathPrefixFilter map[string]bool

+ func NewServer(opts ...ServerOption) *Server

+ func (s *Server) AddPathPrefix(prefix string)

+ func (s *Server) Run(ctx context.Context) error

+ type ServerOption func(*Server)

+ func AddApiGroup(group ...ApiGroup) ServerOption

+ func AddRouteGroup(prefix string, routes func(*gin.RouterGroup)) ServerOption

+ func WithAutoRegister() ServerOption

+ func WithBasePath(basePath ...string) ServerOption

+ func WithCORS(allowOrigins ...string) ServerOption

+ func WithEmbeddedFiles(urlPath string, embeddedFS embed.FS, fsRoot string) ServerOption

+ func WithHealthCheck() ServerOption

+ func WithMode(mode string) ServerOption

+ func WithPProf() ServerOption

+ func WithPort(port int) ServerOption

+ func WithStaticFiles(urlPath, dirPath string) ServerOption

+ func WithSwagger(swaggerOption ...cyswag.RegisterOption) ServerOption

+ func WithVersionInfo() ServerOption

+ type StaticFileConfig struct

+ DirPath string

+ UrlPath string

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