ginKit

package

Go to main page

Versions in this module

v2

v2.1.0

Jun 3, 2023

v2.0.19

May 30, 2023

v2.0.18

May 26, 2023

v2.0.17

May 23, 2023

Changes in this version

type CorsConfig

+ Access bool

v2.0.16

May 15, 2023

Changes in this version

type Config

+ func (config *Config) Verify() error

v2.0.15

Apr 24, 2023

v2.0.14

Apr 20, 2023

v2.0.13

Apr 20, 2023

Changes in this version

type Config

+ Pprof bool

v2.0.12

Apr 16, 2023

v2.0.11

Apr 12, 2023

Changes in this version

type Config

+ func (config *Config) CheckAndPolyfill() error

type MiddlewareConfig

+ BodyLimit int64

v2.0.10

Apr 10, 2023

Changes in this version

+ func ObtainBoolParam(ctx *gin.Context, key string, safeArgs ...bool) (bool, error)

+ func ObtainFloat32Param(ctx *gin.Context, key string, safeArgs ...bool) (float32, error)

+ func ObtainFloat64Param(ctx *gin.Context, key string, safeArgs ...bool) (float64, error)

+ func ObtainFormFileContent(ctx *gin.Context, key string, safeArgs ...bool) ([]byte, string, error)

+ func ObtainGetParam(ctx *gin.Context, key string) string

+ func ObtainInt32Param(ctx *gin.Context, key string, safeArgs ...bool) (int32, error)

+ func ObtainInt64Param(ctx *gin.Context, key string, safeArgs ...bool) (int64, error)

+ func ObtainIntParam(ctx *gin.Context, key string, safeArgs ...bool) (int, error)

+ func ObtainParam(ctx *gin.Context, key string, safeArgs ...bool) string

+ func ObtainPostParam(ctx *gin.Context, key string, safeArgs ...bool) string

v2.0.9

Apr 6, 2023

v2.0.8

Apr 6, 2023

v2.0.6

Apr 6, 2023

v2.0.5

Apr 6, 2023

Changes in this version

+ var SafeParamCapture = &paramCapture

+ var UnsafeParamCapture = &paramCapture

+ func AddHeader(ctx *gin.Context, key, value string)

+ func AttachCommonMiddlewares(engine *gin.Engine, middlewareConfig *MiddlewareConfig, ...) error

+ func DelHeader(ctx *gin.Context, key string)

+ func FaviconByDefault(group IGroup) error

+ func GetBoolParam(ctx *gin.Context, key string, def bool) bool

+ func GetClientIp(ctx *gin.Context) string

+ func GetFloat32Param(ctx *gin.Context, key string, def float32) float32

+ func GetFloat64Param(ctx *gin.Context, key string, def float64) float64

+ func GetFormFile(ctx *gin.Context, key string) (*multipart.FileHeader, error)

+ func GetFormFileContent(ctx *gin.Context, key string) ([]byte, string, error)

+ func GetHeader(ctx *gin.Context, key string) string

+ func GetIntParam(ctx *gin.Context, key string, def int) int

+ func GetParam(ctx *gin.Context, key string) string

+ func GetParamFromGet(ctx *gin.Context, key string) string

+ func GetParamFromPost(ctx *gin.Context, key string) string

+ func GetRequestRoute(ctx *gin.Context) string

+ func GetUserAgent(ctx *gin.Context) string

+ func Initialize(colorful bool)

+ func LoadHtmlFiles(engine IEngine, filePaths ...string)

+ func LoadHtmlGlob(engine IEngine, pattern string)

+ func MustSetUp(config *Config, recoveryMiddleware gin.HandlerFunc, ...)

+ func NewCorsMiddleware(origins []string) gin.HandlerFunc

+ func NewEngine() *gin.Engine

+ func NewOpenCorsMiddleware() gin.HandlerFunc

+ func NoRoute(engine IEngine, handlers ...gin.HandlerFunc)

+ func NoRouteByDefault(engine IEngine) error

+ func OnDebugChanged()

+ func RegisterHandlersToRoute(group IGroup, route string, methods []string, handlers ...gin.HandlerFunc)

+ func RegisterHandlersToRoutes(group IGroup, routes []string, methods []string, handlers ...gin.HandlerFunc)

+ func RespondError(ctx *gin.Context, httpStatusCode int, err error)

+ func RespondFile(ctx *gin.Context, httpStatusCode int, path, name string)

+ func RespondFileContent(ctx *gin.Context, httpStatusCode int, name, contentType string, data []byte)

+ func RespondFileFromFS(ctx *gin.Context, httpStatusCode int, filePath string, fs http.FileSystem)

+ func RespondHtml(ctx *gin.Context, httpStatusCode int, htmlData []byte)

+ func RespondIcon(ctx *gin.Context, httpStatusCode int, iconData []byte)

+ func RespondJson(ctx *gin.Context, statusCode int, h gin.H)

+ func RespondPackage(ctx *gin.Context, pack *ResponsePackage)

+ func RespondPackageOrError(ctx *gin.Context, pack *ResponsePackage, err error)

+ func RespondPanic(ctx *gin.Context, err any)

+ func RespondPdfContentToPrint(ctx *gin.Context, httpStatusCode int, pdfContent []byte)

+ func RespondText(ctx *gin.Context, statusCode int, format string, args ...interface{})

+ func SetCacheControlNoCache(ctx *gin.Context)

+ func SetCacheControlNoStore(ctx *gin.Context)

+ func SetHeader(ctx *gin.Context, key, value string)

+ func SetHttpStatusCode(ctx *gin.Context, statusCode int)

+ func StaticDir(group IGroup, relativePath, dirPath string, listDirectory bool)

+ func StaticFile(group IGroup, relativePath, filePath string)

+ func WrapToHandlerFunc(handler Handler) gin.HandlerFunc

+ type Config struct

+ Colorful bool

+ Host string

+ Middleware *MiddlewareConfig

+ Port int

+ SSL *SslConfig

+ func (config *Config) Check() error

+ type CorsConfig struct

+ Origins []string

+ type Handler func(ctx *gin.Context) (*ResponsePackage, error)

+ type IEngine interface

+ LoadHTMLFiles func(filePaths ...string)

+ LoadHTMLGlob func(pattern string)

+ NoRoute func(handlers ...gin.HandlerFunc)

+ type IGroup interface

+ Any func(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

+ Handle func(httpMethod, relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

+ Static func(relativePath, root string) gin.IRoutes

+ StaticFS func(relativePath string, fs http.FileSystem) gin.IRoutes

+ StaticFile func(relativePath, filepath string) gin.IRoutes

+ type MiddlewareConfig struct

+ Cors *CorsConfig

+ Gzip bool

+ Referer []*refererKit.RefererVerifierBuilder

+ XFrameOptions string

+ type ResponsePackage struct

+ ContentType string

+ Error error

+ FileContent []byte

+ FileName string

+ FilePath string

+ StatusCode int

+ Text string

+ type SslConfig struct

+ CertFile string

+ KeyFile string

+ Port int

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