sgin

package module

Go to main page

Versions in this module

v1

v1.0.6

Feb 9, 2026

v1.0.5

Jan 1, 2026

Changes in this version

+ type Claims struct

+ Data T

+ type JWT struct

+ Issuer string

+ Key string

+ Method jwt.SigningMethod

+ Secret []byte

+ Timeout time.Duration

+ func NewJWT[T any](key string, secret []byte, timeout time.Duration, opts ...func(*JWT[T])) *JWT[T]

+ func (j *JWT[T]) Auth(failure func(*Ctx, *jwt.Token, error) error, opts ...jwt.ParserOption) Handler

+ func (j *JWT[T]) Issue(data T) (string, error)

+ func (j *JWT[T]) IssueWith(data T, setup func(*Claims[T])) (string, error)

+ func (j *JWT[T]) Parse(signed string, opts ...jwt.ParserOption) (*Claims[T], *jwt.Token, error)

+ func (j *JWT[T]) Token(gc *gin.Context) string

v1.0.4

Dec 30, 2025

Changes in this version

type Config

+ Cors func(*cors.Config)

+ func DefaultConfig(config ...Config) (cfg Config)

v1.0.3

Dec 29, 2025

Changes in this version

type Ctx

+ func (c *Ctx) AddURI(key, value string) *Ctx

+ func (c *Ctx) URI(key string) string

v1.0.2

Dec 28, 2025

Changes in this version

type Ctx

+ func (c *Ctx) SendBytes(data []byte) error

+ func (c *Ctx) SendRedirect(loc string) error

v1.0.1

Dec 28, 2025

Changes in this version

type Ctx

+ Uris gin.Params

+ func (c *Ctx) AddUri(key, value string) *Ctx

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

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

+ func (c *Ctx) Err() error

+ func (c *Ctx) ParamAny(key string, def ...any) any

+ func (c *Ctx) ParamArray(key string) []string

+ func (c *Ctx) ParamBool(key string, def ...any) bool

+ func (c *Ctx) ParamDuration(key string, def ...any) time.Duration

+ func (c *Ctx) ParamFile(key string) (*multipart.FileHeader, error)

+ func (c *Ctx) ParamFloat32(key string, def ...any) float32

+ func (c *Ctx) ParamFloat64(key string, def ...any) float64

+ func (c *Ctx) ParamInt(key string, def ...any) int

+ func (c *Ctx) ParamInt16(key string, def ...any) int16

+ func (c *Ctx) ParamInt32(key string, def ...any) int32

+ func (c *Ctx) ParamInt64(key string, def ...any) int64

+ func (c *Ctx) ParamInt8(key string, def ...any) int8

+ func (c *Ctx) ParamMap(key string) map[string]string

+ func (c *Ctx) ParamTime(key string, def ...any) time.Time

+ func (c *Ctx) ParamUint(key string, def ...any) uint

+ func (c *Ctx) ParamUint16(key string, def ...any) uint16

+ func (c *Ctx) ParamUint32(key string, def ...any) uint32

+ func (c *Ctx) ParamUint64(key string, def ...any) uint64

+ func (c *Ctx) ParamUint8(key string, def ...any) uint8

+ func (c *Ctx) Redirect(loc string) error

+ func (c *Ctx) RemoteIP() string

+ func (c *Ctx) SendBinary(data []byte) error

+ func (c *Ctx) SendReader(reader io.Reader, size int64, extraHeaders ...map[string]string) error

+ func (c *Ctx) SendSSEvent(name string, message any) error

+ func (c *Ctx) SendStream(step func(w io.Writer) bool) bool

+ func (c *Ctx) Uri(key string) string

v1.0.0

Dec 28, 2025

Changes in this version

+ const DocsHTML

+ const EngineKey

+ const MIMETOML

+ const MIMEYAML

+ const MIMEYAMLX

+ const TypeArray

+ const TypeBoolean

+ const TypeInteger

+ const TypeNumber

+ const TypeObject

+ const TypeString

+ const Version

+ func APIHidden(op *Operation)

+ func DefaultSchemaNamer(t reflect.Type, hint string) string

+ type API struct

+ func NewAPI(f ...func(*API)) *API

+ func (a *API) Field(f reflect.StructField, hint string) (s *Schema)

+ func (a *API) Register(op *Operation, path, method string, arg *HandleArg)

+ func (a *API) Schema(t reflect.Type, hint ...string) *Schema

+ func (a *API) Struct(t reflect.Type, hint ...string) *Schema

+ type AddOperation func(*Operation)

+ type Components struct

+ Schemas *Registry

+ SecuritySchemes map[string]*SecurityScheme

type Ctx

+ func (c *Ctx) SendDownload(file string, name ...string) error

+ func (c *Ctx) SendFile(path string) error

+ func (c *Ctx) SendJSON(data any) error

+ func (c *Ctx) SendTOML(data any) error

+ func (c *Ctx) SendText(data any) error

+ func (c *Ctx) SendXML(data any) error

+ func (c *Ctx) SendYAML(data any) error

+ func (c *Ctx) ValueDuration(key string, def ...any) time.Duration

+ func (c *Ctx) ValueFloat32(key string, def ...any) float32

+ func (c *Ctx) ValueInt16(key string, def ...any) int16

+ func (c *Ctx) ValueInt32(key string, def ...any) int32

+ func (c *Ctx) ValueInt8(key string, def ...any) int8

+ func (c *Ctx) ValueTime(key string, def ...any) time.Time

+ func (c *Ctx) ValueUint(key string, def ...any) uint

+ func (c *Ctx) ValueUint16(key string, def ...any) uint16

+ func (c *Ctx) ValueUint32(key string, def ...any) uint32

+ func (c *Ctx) ValueUint64(key string, def ...any) uint64

+ func (c *Ctx) ValueUint8(key string, def ...any) uint8

+ type HandleArg struct

+ In reflect.Type

+ Out reflect.Type

+ type HandleMeta struct

+ func (m *HandleMeta) Delete(h Handler)

+ func (m *HandleMeta) Get(h Handler) (*HandleArg, bool)

+ func (m *HandleMeta) Pop(h Handler) (a *HandleArg)

+ func (m *HandleMeta) Set(h Handler, meta *HandleArg)

type Handler

+ func H[I any, R any](f func(*Ctx, I) (R, error)) Handler

+ func He(f func(*Ctx) error) Handler

+ func Hn(f func(*Ctx)) Handler

+ func Ho[I any, R any](f func(*Ctx, I) R) Handler

type IRouter

+ Any func(string, Handler, ...AddOperation) IRouter

+ HEAD func(string, Handler, ...AddOperation) IRouter

+ Match func([]string, string, Handler, ...AddOperation) IRouter

+ OPTIONS func(string, Handler, ...AddOperation) IRouter

+ PATCH func(string, Handler, ...AddOperation) IRouter

+ StaticFS func(string, http.FileSystem) IRouter

+ StaticFile func(string, string) IRouter

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

+ type Info struct

+ Title string

+ Version string

+ type MediaType struct

+ Schema *Schema

+ type OpenAPI struct

+ Components *Components

+ Info *Info

+ OpenAPI string

+ Paths map[string]*PathItem

+ Security []Requirement

+ Tags []*Tag

+ func (a *OpenAPI) YAML() ([]byte, error)

+ type Operation struct

+ Description string

+ Hidden bool

+ Parameters []*Param

+ RequestBody *RequestBody

+ Responses map[string]*ResponseBody

+ Security []Requirement

+ Summary string

+ Tags []string

+ func (o *Operation) Clone() *Operation

+ type Param struct

+ Description string

+ In string

+ Name string

+ Ref string

+ Required bool

+ Schema *Schema

+ type PathItem struct

+ Delete *Operation

+ Description string

+ Get *Operation

+ Head *Operation

+ Options *Operation

+ Parameters []*Param

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ Ref string

+ Summary string

+ Trace *Operation

type RecoverInfo

+ Accept string

+ type Registry struct

+ Namer func(reflect.Type, string) string

+ Prefix string

+ func NewRegistry(prefix string, namer func(reflect.Type, string) string) *Registry

+ func (r *Registry) DecodeJSON(value, field string, s *Schema) any

+ func (r *Registry) Field(f reflect.StructField, hint string) (s *Schema)

+ func (r *Registry) MarshalYAML() (any, error)

+ func (r *Registry) Ref(ref string) *Schema

+ func (r *Registry) Schema(t reflect.Type, hint ...string) *Schema

+ func (r *Registry) Struct(t reflect.Type, hint ...string) *Schema

+ type RequestBody struct

+ Content map[string]*MediaType

+ Description string

+ Ref string

+ Required bool

+ type Requirement map[string][]string

+ type ResponseBody struct

+ Content map[string]*MediaType

+ Description string

+ Headers map[string]*Param

+ Ref string

+ type Result struct

+ Code int

+ Count int

+ Data any

+ Event string

+ Msg string

+ Status int

+ func (r *Result) Failed(data ...any) (res *Result)

+ func (r *Result) NewFailed(data ...any) *Result

+ func (r *Result) OK(data ...any) (res *Result)

+ func (r *Result) SetCode(code any) *Result

+ func (r *Result) SetEvent(e string) *Result

+ func (r *Result) SetMsg(format any, a ...any) *Result

+ func (r *Result) SetStatus(status any, code ...any) (res *Result)

type Router

+ func (r *Router) Any(path string, h Handler, ops ...AddOperation) IRouter

+ func (r *Router) HEAD(path string, h Handler, ops ...AddOperation) IRouter

+ func (r *Router) Match(methods []string, path string, h Handler, ops ...AddOperation) IRouter

+ func (r *Router) OPTIONS(path string, h Handler, ops ...AddOperation) IRouter

+ func (r *Router) PATCH(path string, h Handler, ops ...AddOperation) IRouter

+ func (r *Router) StaticFS(name string, root http.FileSystem) IRouter

+ func (r *Router) StaticFile(name, root string) IRouter

+ func (r *Router) StaticFileFS(name, root string, fs http.FileSystem) IRouter

+ type Schema struct

+ AdditionalProperties any

+ ContentEncoding string

+ Default any

+ Description string

+ Enum []any

+ Format string

+ Items *Schema

+ Nullable bool

+ Properties map[string]*Schema

+ Ref string

+ Required []string

+ Title string

+ Type any

+ func (s *Schema) MarshalYAML() (any, error)

+ type SecurityScheme struct

+ BearerFormat string

+ Description string

+ In string

+ Name string

+ Scheme string

+ Type string

+ type Tag struct

+ Description string

+ Name string

v0

v0.0.13

Dec 22, 2025

Changes in this version

+ const FmtDownload

+ const FmtHTML

+ const FmtJSON

+ const FmtText

+ const FmtUpload

+ const FmtXML

+ type Body struct

+ func BodyDownload(data any) Body

+ func BodyHTML(name string, data any) Body

+ func BodyJSON(data any) Body

+ func BodyText(data any) Body

+ func BodyUpload(data any) Body

+ func BodyXML(data any) Body

v0.0.12

Dec 21, 2025

Changes in this version

type Ctx

+ func (c *Ctx) GetHeader(key string, value ...string) string

v0.0.11

Dec 21, 2025

Changes in this version

+ func SupportedLanguages() []language.Tag

v0.0.10

Dec 21, 2025

Changes in this version

type Config

+ Locales []Locale

type Ctx

+ func (c *Ctx) Locale() language.Tag

+ func (c *Ctx) SetLocale(locale language.Tag)

type Engine

+ func (e *Engine) Gin() *gin.Engine

+ type Locale struct

+ New locales.Translator

+ Register func(*validator.Validate, ut.Translator) error

v0.0.9

Dec 19, 2025

Changes in this version

+ type RecoverInfo struct

+ ContentType string

+ Error string

+ Host string

+ IP string

+ Method string

+ Path string

+ Sources []*Stack

+ Time string

+ Traceid string

+ func (r *RecoverInfo) JSON() string

+ func (r *RecoverInfo) String() string

+ type Stack struct

+ File string

+ Func string

+ Line int

+ Source string

v0.0.8

Dec 18, 2025

Changes in this version

type Error

+ func ErrEntityTooLarge(msg ...string) *Error

+ func ErrHeaderFieldsTooLarge(msg ...string) *Error

+ func ErrRangeNotSatisfiable(msg ...string) *Error

+ func ErrTimeout(msg ...string) *Error

+ func ErrURITooLong(msg ...string) *Error

+ func NotModified(msg ...string) *Error

v0.0.7

Dec 17, 2025

Changes in this version

+ const CtxKey

+ const FormatText

+ const HeaderAccessControlAllowPrivateNetwork

+ const HeaderAccessControlRequestPrivateNetwork

+ const MIMECBOR

+ const MIMEForm

+ const MIMEJSON

+ const MIMEJSONUTF8

+ const MIMEJavaScript

+ const MIMEMsgPack

+ const MIMETextCSS

+ const MIMETextCSSUTF8

+ const MIMETextHTMLUTF8

+ const MIMETextJavaScriptUTF8

+ const MIMETextPlainUTF8

+ const MIMETextXMLUTF8

+ const MIMETextYAML

+ const MIMETextYAMLUTF8

+ const MIMEXML

+ const MIMEXMLUTF8

+ func Logger(c *Ctx)

+ func Recovery(c *Ctx)

type Config

+ Logger func(*Ctx, string, string) bool

+ OpenAPI *oa.OpenAPI

type Ctx

+ func (c *Ctx) Content(value string) *Ctx

+ func (c *Ctx) Get(key string, value ...any) any

+ func (c *Ctx) Gin() *gin.Context

+ func (c *Ctx) TraceID() string

+ func (c *Ctx) Value(key string, def ...string) string

+ func (c *Ctx) ValueAny(key string, def ...any) any

+ func (c *Ctx) ValueBool(key string, def ...any) bool

+ func (c *Ctx) ValueFile(key string) (*multipart.FileHeader, error)

+ func (c *Ctx) ValueFloat64(key string, def ...any) float64

+ func (c *Ctx) ValueInt(key string, def ...any) int

+ func (c *Ctx) ValueInt64(key string, def ...any) int64

+ func (c *Ctx) Values() map[string]any

type Engine

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

+ type IRouter interface

+ DELETE func(string, ...Handler) IRouter

+ GET func(string, ...Handler) IRouter

+ Group func(string, ...Handler) IRouter

+ Handle func(method, path string, handlers ...Handler) IRouter

+ POST func(string, ...Handler) IRouter

+ PUT func(string, ...Handler) IRouter

+ Static func(path, root string) IRouter

+ Use func(...Handler) IRouter

v0.0.6

Mar 18, 2025

Changes in this version

type Route

+ func (r *Route) DELETE(path string, handlers ...Handler) Router

+ func (r *Route) PUT(path string, handlers ...Handler) Router

type Router

+ DELETE func(path string, handlers ...Handler) Router

+ PUT func(path string, handlers ...Handler) Router

v0.0.5

Mar 17, 2025

v0.0.4

Mar 11, 2025

Changes in this version

type Response

+ func (r *Response) Failed(data any) *Response

+ func (r *Response) OK(data any) *Response

v0.0.3

Dec 11, 2024

v0.0.2

Dec 11, 2024

v0.0.1

Dec 11, 2024

Changes in this version

+ const FormatDownload

+ const FormatJSON

+ const FormatString

+ const FormatUpload

+ const FormatXML

+ const HeaderAccept

+ const HeaderAcceptCH

+ const HeaderAcceptCHLifetime

+ const HeaderAcceptCharset

+ const HeaderAcceptEncoding

+ const HeaderAcceptLanguage

+ const HeaderAcceptPatch

+ const HeaderAcceptPushPolicy

+ const HeaderAcceptRanges

+ const HeaderAcceptSignature

+ const HeaderAccessControlAllowCredentials

+ const HeaderAccessControlAllowHeaders

+ const HeaderAccessControlAllowMethods

+ const HeaderAccessControlAllowOrigin

+ const HeaderAccessControlExposeHeaders

+ const HeaderAccessControlMaxAge

+ const HeaderAccessControlRequestHeaders

+ const HeaderAccessControlRequestMethod

+ const HeaderAge

+ const HeaderAllow

+ const HeaderAltSvc

+ const HeaderAuthorization

+ const HeaderCacheControl

+ const HeaderClearSiteData

+ const HeaderConnection

+ const HeaderContentDPR

+ const HeaderContentDisposition

+ const HeaderContentEncoding

+ const HeaderContentLanguage

+ const HeaderContentLength

+ const HeaderContentLocation

+ const HeaderContentRange

+ const HeaderContentSecurityPolicy

+ const HeaderContentSecurityPolicyReportOnly

+ const HeaderContentType

+ const HeaderCookie

+ const HeaderCrossOriginResourcePolicy

+ const HeaderDNT

+ const HeaderDPR

+ const HeaderDate

+ const HeaderETag

+ const HeaderEarlyData

+ const HeaderExpect

+ const HeaderExpectCT

+ const HeaderExpires

+ const HeaderForwarded

+ const HeaderFrom

+ const HeaderHost

+ const HeaderIfMatch

+ const HeaderIfModifiedSince

+ const HeaderIfNoneMatch

+ const HeaderIfRange

+ const HeaderIfUnmodifiedSince

+ const HeaderIndex

+ const HeaderKeepAlive

+ const HeaderLargeAllocation

+ const HeaderLastEventID

+ const HeaderLastModified

+ const HeaderLink

+ const HeaderLocation

+ const HeaderMaxForwards

+ const HeaderNEL

+ const HeaderOrigin

+ const HeaderPermissionsPolicy

+ const HeaderPingFrom

+ const HeaderPingTo

+ const HeaderPragma

+ const HeaderProxyAuthenticate

+ const HeaderProxyAuthorization

+ const HeaderPublicKeyPins

+ const HeaderPublicKeyPinsReportOnly

+ const HeaderPushPolicy

+ const HeaderRange

+ const HeaderReferer

+ const HeaderReferrerPolicy

+ const HeaderReportTo

+ const HeaderRetryAfter

+ const HeaderSaveData

+ const HeaderSecWebSocketAccept

+ const HeaderSecWebSocketExtensions

+ const HeaderSecWebSocketKey

+ const HeaderSecWebSocketProtocol

+ const HeaderSecWebSocketVersion

+ const HeaderServer

+ const HeaderServerTiming

+ const HeaderSetCookie

+ const HeaderSignature

+ const HeaderSignedHeaders

+ const HeaderSourceMap

+ const HeaderStrictTransportSecurity

+ const HeaderTE

+ const HeaderTimingAllowOrigin

+ const HeaderTk

+ const HeaderTrailer

+ const HeaderTransferEncoding

+ const HeaderUpgrade

+ const HeaderUpgradeInsecureRequests

+ const HeaderUserAgent

+ const HeaderVary

+ const HeaderVia

+ const HeaderViewportWidth

+ const HeaderWWWAuthenticate

+ const HeaderWarning

+ const HeaderWidth

+ const HeaderXContentTypeOptions

+ const HeaderXDNSPrefetchControl

+ const HeaderXDownloadOptions

+ const HeaderXForwardedFor

+ const HeaderXForwardedHost

+ const HeaderXForwardedProto

+ const HeaderXForwardedProtocol

+ const HeaderXForwardedSsl

+ const HeaderXFrameOptions

+ const HeaderXPermittedCrossDomainPolicies

+ const HeaderXPingback

+ const HeaderXPoweredBy

+ const HeaderXRequestID

+ const HeaderXRequestedWith

+ const HeaderXRobotsTag

+ const HeaderXUACompatible

+ const HeaderXUrlScheme

+ const HeaderXXSSProtection

+ const MIMEApplicationForm

+ const MIMEApplicationJSON

+ const MIMEApplicationJSONCharsetUTF8

+ const MIMEApplicationXML

+ const MIMEApplicationXMLCharsetUTF8

+ const MIMEMultipartForm

+ const MIMEOctetStream

+ const MIMETextHTML

+ const MIMETextHTMLCharsetUTF8

+ const MIMETextJavaScript

+ const MIMETextJavaScriptCharsetUTF8

+ const MIMETextPlain

+ const MIMETextPlainCharsetUTF8

+ const MIMETextXML

+ const MIMETextXMLCharsetUTF8

+ const StatusAccepted

+ const StatusAlreadyReported

+ const StatusBadGateway

+ const StatusBadRequest

+ const StatusConflict

+ const StatusContinue

+ const StatusCreated

+ const StatusEarlyHints

+ const StatusExpectationFailed

+ const StatusFailedDependency

+ const StatusForbidden

+ const StatusFound

+ const StatusGatewayTimeout

+ const StatusGone

+ const StatusHTTPVersionNotSupported

+ const StatusIMUsed

+ const StatusInsufficientStorage

+ const StatusInternalServerError

+ const StatusLengthRequired

+ const StatusLocked

+ const StatusLoopDetected

+ const StatusMethodNotAllowed

+ const StatusMisdirectedRequest

+ const StatusMovedPermanently

+ const StatusMultiStatus

+ const StatusMultipleChoices

+ const StatusNetworkAuthenticationRequired

+ const StatusNoContent

+ const StatusNonAuthoritativeInformation

+ const StatusNotAcceptable

+ const StatusNotExtended

+ const StatusNotFound

+ const StatusNotImplemented

+ const StatusNotModified

+ const StatusOK

+ const StatusPartialContent

+ const StatusPaymentRequired

+ const StatusPermanentRedirect

+ const StatusPreconditionFailed

+ const StatusPreconditionRequired

+ const StatusProcessing

+ const StatusProxyAuthRequired

+ const StatusRequestEntityTooLarge

+ const StatusRequestHeaderFieldsTooLarge

+ const StatusRequestTimeout

+ const StatusRequestURITooLong

+ const StatusRequestedRangeNotSatisfiable

+ const StatusResetContent

+ const StatusSeeOther

+ const StatusServiceUnavailable

+ const StatusSwitchProxy

+ const StatusSwitchingProtocols

+ const StatusTeapot

+ const StatusTemporaryRedirect

+ const StatusTooEarly

+ const StatusTooManyRequests

+ const StatusUnauthorized

+ const StatusUnavailableForLegalReasons

+ const StatusUnprocessableEntity

+ const StatusUnsupportedMediaType

+ const StatusUpgradeRequired

+ const StatusUseProxy

+ const StatusVariantAlsoNegotiates

+ var ErrBadGateway = NewError(StatusBadGateway)

+ var ErrBadRequest = NewError(StatusBadRequest)

+ var ErrConflict = NewError(StatusConflict)

+ var ErrExpectationFailed = NewError(StatusExpectationFailed)

+ var ErrFailedDependency = NewError(StatusFailedDependency)

+ var ErrForbidden = NewError(StatusForbidden)

+ var ErrGatewayTimeout = NewError(StatusGatewayTimeout)

+ var ErrGone = NewError(StatusGone)

+ var ErrHTTPVersionNotSupported = NewError(StatusHTTPVersionNotSupported)

+ var ErrInsufficientStorage = NewError(StatusInsufficientStorage)

+ var ErrInternalServerError = NewError(StatusInternalServerError)

+ var ErrLengthRequired = NewError(StatusLengthRequired)

+ var ErrLocked = NewError(StatusLocked)

+ var ErrLoopDetected = NewError(StatusLoopDetected)

+ var ErrMethodNotAllowed = NewError(StatusMethodNotAllowed)

+ var ErrMisdirectedRequest = NewError(StatusMisdirectedRequest)

+ var ErrNetworkAuthenticationRequired = NewError(StatusNetworkAuthenticationRequired)

+ var ErrNotAcceptable = NewError(StatusNotAcceptable)

+ var ErrNotExtended = NewError(StatusNotExtended)

+ var ErrNotFound = NewError(StatusNotFound)

+ var ErrNotImplemented = NewError(StatusNotImplemented)

+ var ErrPaymentRequired = NewError(StatusPaymentRequired)

+ var ErrPreconditionFailed = NewError(StatusPreconditionFailed)

+ var ErrPreconditionRequired = NewError(StatusPreconditionRequired)

+ var ErrProxyAuthRequired = NewError(StatusProxyAuthRequired)

+ var ErrRequestEntityTooLarge = NewError(StatusRequestEntityTooLarge)

+ var ErrRequestHeaderFieldsTooLarge = NewError(StatusRequestHeaderFieldsTooLarge)

+ var ErrRequestTimeout = NewError(StatusRequestTimeout)

+ var ErrRequestURITooLong = NewError(StatusRequestURITooLong)

+ var ErrRequestedRangeNotSatisfiable = NewError(StatusRequestedRangeNotSatisfiable)

+ var ErrServiceUnavailable = NewError(StatusServiceUnavailable)

+ var ErrTeapot = NewError(StatusTeapot)

+ var ErrTooEarly = NewError(StatusTooEarly)

+ var ErrTooManyRequests = NewError(StatusTooManyRequests)

+ var ErrUnauthorized = NewError(StatusUnauthorized)

+ var ErrUnavailableForLegalReasons = NewError(StatusUnavailableForLegalReasons)

+ var ErrUnprocessableEntity = NewError(StatusUnprocessableEntity)

+ var ErrUnsupportedMediaType = NewError(StatusUnsupportedMediaType)

+ var ErrUpgradeRequired = NewError(StatusUpgradeRequired)

+ var ErrVariantAlsoNegotiates = NewError(StatusVariantAlsoNegotiates)

+ func DefaultErrorHandler(c *Ctx, err error) error

+ type Config struct

+ ErrorHandler func(*Ctx, error) error

+ Mode string

+ Recovery func(*Ctx, string)

+ TrustedProxies []string

+ type Ctx struct

+ Keys map[string]any

+ Params gin.Params

+ Request *http.Request

+ Writer gin.ResponseWriter

+ func (c *Ctx) Arg(key string, or ...string) string

+ func (c *Ctx) ArgBool(key string) bool

+ func (c *Ctx) ArgFloat64(key string, or ...float64) float64

+ func (c *Ctx) ArgInt(key string, or ...int) int

+ func (c *Ctx) ArgInt64(key string, or ...int64) int64

+ func (c *Ctx) Args() (args map[string]any)

+ func (c *Ctx) Cookie(name string) (string, error)

+ func (c *Ctx) Header(key string, value ...string) string

+ func (c *Ctx) IP() (ip string)

+ func (c *Ctx) Locals(key string, value ...any) any

+ func (c *Ctx) Method() string

+ func (c *Ctx) Next() error

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

+ func (c *Ctx) Path(full ...bool) string

+ func (c *Ctx) RawBody() (body []byte)

+ func (c *Ctx) SaveFile(file *multipart.FileHeader, dst string) error

+ func (c *Ctx) Send(body any, format ...string) error

+ func (c *Ctx) SendHTML(name string, data any) error

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

+ func (c *Ctx) SetHeader(key string, value string)

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

+ func (c *Ctx) StatusCode() int

+ type Engine struct

+ func New(config ...Config) *Engine

+ func (e *Engine) Handler() http.Handler

+ func (e *Engine) Routes() gin.RoutesInfo

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

+ func (e *Engine) RunServeTLS(listener net.Listener, certFile string, keyFile string) (err error)

+ func (e *Engine) RunServer(listener net.Listener) (err error)

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

+ type Error struct

+ Code int

+ Message string

+ func NewError(code int, message ...string) *Error

+ func (e *Error) Error() string

+ type Handler any

+ type Response struct

+ Code int

+ Count int

+ Data any

+ Event string

+ Message string

+ Status int

+ func (r *Response) SetCode(code any) *Response

+ func (r *Response) SetData(data any) *Response

+ func (r *Response) SetEvent(event string) *Response

+ func (r *Response) SetFailData(data any) *Response

+ func (r *Response) SetMessage(msg any) *Response

+ func (r *Response) SetStatus(status any, code ...any) *Response

+ type Route struct

+ func (r *Route) GET(path string, handlers ...Handler) Router

+ func (r *Route) Group(path string, handlers ...Handler) Router

+ func (r *Route) Handle(method string, path string, handlers ...Handler) Router

+ func (r *Route) POST(path string, handlers ...Handler) Router

+ func (r *Route) Static(path, root string) Router

+ func (r *Route) Use(args ...Handler) Router

+ type Router interface

+ GET func(path string, handlers ...Handler) Router

+ Group func(path string, handlers ...Handler) Router

+ Handle func(method, path string, handlers ...Handler) Router

+ POST func(path string, handlers ...Handler) Router

+ Static func(path, root string) Router

+ Use func(args ...Handler) Router

Other modules containing this package

github.com/baagod/sgin/v2

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