gin

package module

Go to main page

Versions in this module

v1

v1.2.1

Jun 7, 2024

v1.2.0

Jun 7, 2024

Changes in this version

type ContextRequest

+ func (r *ContextRequest) Cookie(key string, defaultValue ...string) string

+ func (r *ContextRequest) HasSession() bool

+ func (r *ContextRequest) Session() contractsession.Session

+ func (r *ContextRequest) SetSession(session contractsession.Session) contractshttp.ContextRequest

type ContextResponse

+ func (r *ContextResponse) Cookie(cookie contractshttp.Cookie) contractshttp.ContextResponse

+ func (r *ContextResponse) NoContent(code ...int) contractshttp.Response

+ func (r *ContextResponse) WithoutCookie(name string) contractshttp.ContextResponse

+ type NoContentResponse struct

+ func (r *NoContentResponse) Render() error

v1.1.7

Mar 24, 2024

v1.1.6

Nov 9, 2023

v1.1.5

Sep 11, 2023

v1.1.4

Sep 10, 2023

Changes in this version

+ var ViewFacade http.View

+ func Cors() http.Middleware

+ func DefaultTemplate() (*render.HTMLProduction, error)

+ func NewContextRequest(ctx *Context, log log.Log, validation contractsvalidate.Validation) contractshttp.ContextRequest

+ func NewStatus(instance *gin.Context, code int) contractshttp.ResponseSuccess

+ func NewTemplate(options RenderOptions) (*render.HTMLProduction, error)

+ func Tls() contractshttp.Middleware

+ type ContextRequest struct

+ func (r *ContextRequest) AbortWithStatus(code int)

+ func (r *ContextRequest) AbortWithStatusJson(code int, jsonObj any)

+ func (r *ContextRequest) All() map[string]any

+ func (r *ContextRequest) Bind(obj any) error

+ func (r *ContextRequest) File(name string) (contractsfilesystem.File, error)

+ func (r *ContextRequest) Form(key string, defaultValue ...string) string

+ func (r *ContextRequest) FullUrl() string

+ func (r *ContextRequest) Header(key string, defaultValue ...string) string

+ func (r *ContextRequest) Headers() http.Header

+ func (r *ContextRequest) Host() string

+ func (r *ContextRequest) Input(key string, defaultValue ...string) string

+ func (r *ContextRequest) InputArray(key string, defaultValue ...[]string) []string

+ func (r *ContextRequest) InputBool(key string, defaultValue ...bool) bool

+ func (r *ContextRequest) InputInt(key string, defaultValue ...int) int

+ func (r *ContextRequest) InputInt64(key string, defaultValue ...int64) int64

+ func (r *ContextRequest) InputMap(key string, defaultValue ...map[string]string) map[string]string

+ func (r *ContextRequest) Ip() string

+ func (r *ContextRequest) Json(key string, defaultValue ...string) string

+ func (r *ContextRequest) Method() string

+ func (r *ContextRequest) Next()

+ func (r *ContextRequest) Origin() *http.Request

+ func (r *ContextRequest) Path() string

+ func (r *ContextRequest) Queries() map[string]string

+ func (r *ContextRequest) Query(key string, defaultValue ...string) string

+ func (r *ContextRequest) QueryArray(key string) []string

+ func (r *ContextRequest) QueryBool(key string, defaultValue ...bool) bool

+ func (r *ContextRequest) QueryInt(key string, defaultValue ...int) int

+ func (r *ContextRequest) QueryInt64(key string, defaultValue ...int64) int64

+ func (r *ContextRequest) QueryMap(key string) map[string]string

+ func (r *ContextRequest) Route(key string) string

+ func (r *ContextRequest) RouteInt(key string) int

+ func (r *ContextRequest) RouteInt64(key string) int64

+ func (r *ContextRequest) Url() string

+ func (r *ContextRequest) Validate(rules map[string]string, options ...contractsvalidate.Option) (contractsvalidate.Validator, error)

+ func (r *ContextRequest) ValidateRequest(request contractshttp.FormRequest) (contractsvalidate.Errors, error)

+ type ContextResponse struct

+ func NewContextResponse(instance *gin.Context, origin contractshttp.ResponseOrigin) *ContextResponse

+ func (r *ContextResponse) Data(code int, contentType string, data []byte) contractshttp.Response

+ func (r *ContextResponse) Download(filepath, filename string) contractshttp.Response

+ func (r *ContextResponse) File(filepath string) contractshttp.Response

+ func (r *ContextResponse) Flush()

+ func (r *ContextResponse) Header(key, value string) contractshttp.ContextResponse

+ func (r *ContextResponse) Json(code int, obj any) contractshttp.Response

+ func (r *ContextResponse) Origin() contractshttp.ResponseOrigin

+ func (r *ContextResponse) Redirect(code int, location string) contractshttp.Response

+ func (r *ContextResponse) Status(code int) contractshttp.ResponseStatus

+ func (r *ContextResponse) String(code int, format string, values ...any) contractshttp.Response

+ func (r *ContextResponse) Success() contractshttp.ResponseSuccess

+ func (r *ContextResponse) View() contractshttp.ResponseView

+ func (r *ContextResponse) Writer() http.ResponseWriter

+ type DataResponse struct

+ func (r *DataResponse) Render() error

+ type Delims struct

+ Left string

+ Right string

+ type DownloadResponse struct

+ func (r *DownloadResponse) Render() error

+ type FileResponse struct

+ func (r *FileResponse) Render() error

+ type HtmlResponse struct

+ func (r *HtmlResponse) Render() error

+ type JsonResponse struct

+ func (r *JsonResponse) Render() error

+ type RedirectResponse struct

+ func (r *RedirectResponse) Render() error

+ type RenderOptions struct

+ Delims *Delims

+ FuncMap template.FuncMap

+ type StringResponse struct

+ func (r *StringResponse) Render() error

+ type View struct

+ func NewView(instance *gin.Context) *View

+ func (receive *View) First(views []string, data ...any) contractshttp.Response

+ func (receive *View) Make(view string, data ...any) contractshttp.Response

v1.1.3

Aug 12, 2023

v1.1.2

Aug 11, 2023

Changes in this version

type Response

+ func (r *Response) Flush()

v1.1.1

Aug 11, 2023

v1.1.0

Aug 11, 2023

Changes in this version

+ func NewContext(ctx *gin.Context) http.Context

+ func NewGroup(instance gin.IRouter, prefix string, ...) route.Route

+ func NewRequest(ctx *Context, log log.Log, validation validatecontract.Validation) httpcontract.Request

+ func ResponseMiddleware() httpcontract.Middleware

type BodyWriter

+ func (w *BodyWriter) Header() http.Header

+ type Context struct

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

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

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

+ func (c *Context) Err() error

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

+ func (c *Context) Request() http.Request

+ func (c *Context) Response() http.Response

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

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

+ type Group struct

+ func (r *Group) Any(relativePath string, handler httpcontract.HandlerFunc)

+ func (r *Group) Delete(relativePath string, handler httpcontract.HandlerFunc)

+ func (r *Group) Get(relativePath string, handler httpcontract.HandlerFunc)

+ func (r *Group) Group(handler route.GroupFunc)

+ func (r *Group) Middleware(middlewares ...httpcontract.Middleware) route.Route

+ func (r *Group) Options(relativePath string, handler httpcontract.HandlerFunc)

+ func (r *Group) Patch(relativePath string, handler httpcontract.HandlerFunc)

+ func (r *Group) Post(relativePath string, handler httpcontract.HandlerFunc)

+ func (r *Group) Prefix(addr string) route.Route

+ func (r *Group) Put(relativePath string, handler httpcontract.HandlerFunc)

+ func (r *Group) Resource(relativePath string, controller httpcontract.ResourceController)

+ func (r *Group) Static(relativePath, root string)

+ func (r *Group) StaticFS(relativePath string, fs http.FileSystem)

+ func (r *Group) StaticFile(relativePath, filepath string)

+ type Request struct

+ func (r *Request) AbortWithStatus(code int)

+ func (r *Request) AbortWithStatusJson(code int, jsonObj any)

+ func (r *Request) All() map[string]any

+ func (r *Request) Bind(obj any) error

+ func (r *Request) File(name string) (filesystemcontract.File, error)

+ func (r *Request) Form(key string, defaultValue ...string) string

+ func (r *Request) FullUrl() string

+ func (r *Request) Header(key string, defaultValue ...string) string

+ func (r *Request) Headers() http.Header

+ func (r *Request) Host() string

+ func (r *Request) Input(key string, defaultValue ...string) string

+ func (r *Request) InputBool(key string, defaultValue ...bool) bool

+ func (r *Request) InputInt(key string, defaultValue ...int) int

+ func (r *Request) InputInt64(key string, defaultValue ...int64) int64

+ func (r *Request) Ip() string

+ func (r *Request) Json(key string, defaultValue ...string) string

+ func (r *Request) Method() string

+ func (r *Request) Next()

+ func (r *Request) Origin() *http.Request

+ func (r *Request) Path() string

+ func (r *Request) Queries() map[string]string

+ func (r *Request) Query(key string, defaultValue ...string) string

+ func (r *Request) QueryArray(key string) []string

+ func (r *Request) QueryBool(key string, defaultValue ...bool) bool

+ func (r *Request) QueryInt(key string, defaultValue ...int) int

+ func (r *Request) QueryInt64(key string, defaultValue ...int64) int64

+ func (r *Request) QueryMap(key string) map[string]string

+ func (r *Request) Route(key string) string

+ func (r *Request) RouteInt(key string) int

+ func (r *Request) RouteInt64(key string) int64

+ func (r *Request) Url() string

+ func (r *Request) Validate(rules map[string]string, options ...validatecontract.Option) (validatecontract.Validator, error)

+ func (r *Request) ValidateRequest(request httpcontract.FormRequest) (validatecontract.Errors, error)

+ type Response struct

+ func NewResponse(instance *gin.Context, origin httpcontract.ResponseOrigin) *Response

+ func (r *Response) Data(code int, contentType string, data []byte)

+ func (r *Response) Download(filepath, filename string)

+ func (r *Response) File(filepath string)

+ func (r *Response) Header(key, value string) httpcontract.Response

+ func (r *Response) Json(code int, obj any)

+ func (r *Response) Origin() httpcontract.ResponseOrigin

+ func (r *Response) Redirect(code int, location string)

+ func (r *Response) Status(code int) httpcontract.ResponseStatus

+ func (r *Response) String(code int, format string, values ...any)

+ func (r *Response) Success() httpcontract.ResponseSuccess

+ func (r *Response) Writer() http.ResponseWriter

+ type Route struct

+ func NewRoute(config config.Config) *Route

+ func (r *Route) Fallback(handler httpcontract.HandlerFunc)

+ func (r *Route) GlobalMiddleware(middlewares ...httpcontract.Middleware)

+ func (r *Route) Run(host ...string) error

+ func (r *Route) RunTLS(host ...string) error

+ func (r *Route) RunTLSWithCert(host, certFile, keyFile string) error

+ func (r *Route) ServeHTTP(writer http.ResponseWriter, request *http.Request)

+ type Status struct

+ func (r *Status) Data(contentType string, data []byte)

+ func (r *Status) Json(obj any)

+ func (r *Status) String(format string, values ...any)

+ type Success struct

+ func (r *Success) Data(contentType string, data []byte)

+ func (r *Success) Json(obj any)

+ func (r *Success) String(format string, values ...any)

v1.0.2

Jun 30, 2023

Changes in this version

+ const HttpBinding

+ const RouteBinding

+ var App foundation.Application

+ var CacheFacade cache.Cache

+ var ConfigFacade config.Config

+ var LogFacade log.Log

+ var RateLimiterFacade http.RateLimiter

+ var ValidationFacade validation.Validation

+ func Background() http.Context

+ func GinResponseMiddleware() httpcontract.Middleware

+ func NewGinContext(ctx *gin.Context) http.Context

+ func NewGinGroup(instance gin.IRouter, prefix string, ...) route.Route

+ func NewGinRequest(ctx *GinContext, log log.Log, validation validatecontract.Validation) httpcontract.Request

+ func NewGinStatus(instance *gin.Context, code int) httpcontract.ResponseSuccess

+ func NewGinSuccess(instance *gin.Context) httpcontract.ResponseSuccess

+ type BodyWriter struct

+ func (w *BodyWriter) Body() *bytes.Buffer

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

+ func (w *BodyWriter) WriteString(s string) (int, error)

+ type GinContext struct

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

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

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

+ func (c *GinContext) Err() error

+ func (c *GinContext) Instance() *gin.Context

+ func (c *GinContext) Request() http.Request

+ func (c *GinContext) Response() http.Response

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

+ func (c *GinContext) WithValue(key string, value any)

+ type GinGroup struct

+ func (r *GinGroup) Any(relativePath string, handler httpcontract.HandlerFunc)

+ func (r *GinGroup) Delete(relativePath string, handler httpcontract.HandlerFunc)

+ func (r *GinGroup) Get(relativePath string, handler httpcontract.HandlerFunc)

+ func (r *GinGroup) Group(handler route.GroupFunc)

+ func (r *GinGroup) Middleware(middlewares ...httpcontract.Middleware) route.Route

+ func (r *GinGroup) Options(relativePath string, handler httpcontract.HandlerFunc)

+ func (r *GinGroup) Patch(relativePath string, handler httpcontract.HandlerFunc)

+ func (r *GinGroup) Post(relativePath string, handler httpcontract.HandlerFunc)

+ func (r *GinGroup) Prefix(addr string) route.Route

+ func (r *GinGroup) Put(relativePath string, handler httpcontract.HandlerFunc)

+ func (r *GinGroup) Resource(relativePath string, controller httpcontract.ResourceController)

+ func (r *GinGroup) Static(relativePath, root string)

+ func (r *GinGroup) StaticFS(relativePath string, fs http.FileSystem)

+ func (r *GinGroup) StaticFile(relativePath, filepath string)

+ type GinRequest struct

+ func (r *GinRequest) AbortWithStatus(code int)

+ func (r *GinRequest) AbortWithStatusJson(code int, jsonObj any)

+ func (r *GinRequest) All() map[string]any

+ func (r *GinRequest) Bind(obj any) error

+ func (r *GinRequest) File(name string) (filesystemcontract.File, error)

+ func (r *GinRequest) Form(key string, defaultValue ...string) string

+ func (r *GinRequest) FullUrl() string

+ func (r *GinRequest) Header(key string, defaultValue ...string) string

+ func (r *GinRequest) Headers() http.Header

+ func (r *GinRequest) Host() string

+ func (r *GinRequest) Input(key string, defaultValue ...string) string

+ func (r *GinRequest) InputBool(key string, defaultValue ...bool) bool

+ func (r *GinRequest) InputInt(key string, defaultValue ...int) int

+ func (r *GinRequest) InputInt64(key string, defaultValue ...int64) int64

+ func (r *GinRequest) Ip() string

+ func (r *GinRequest) Json(key string, defaultValue ...string) string

+ func (r *GinRequest) Method() string

+ func (r *GinRequest) Next()

+ func (r *GinRequest) Origin() *http.Request

+ func (r *GinRequest) Path() string

+ func (r *GinRequest) Queries() map[string]string

+ func (r *GinRequest) Query(key string, defaultValue ...string) string

+ func (r *GinRequest) QueryArray(key string) []string

+ func (r *GinRequest) QueryBool(key string, defaultValue ...bool) bool

+ func (r *GinRequest) QueryInt(key string, defaultValue ...int) int

+ func (r *GinRequest) QueryInt64(key string, defaultValue ...int64) int64

+ func (r *GinRequest) QueryMap(key string) map[string]string

+ func (r *GinRequest) Route(key string) string

+ func (r *GinRequest) RouteInt(key string) int

+ func (r *GinRequest) RouteInt64(key string) int64

+ func (r *GinRequest) Url() string

+ func (r *GinRequest) Validate(rules map[string]string, options ...validatecontract.Option) (validatecontract.Validator, error)

+ func (r *GinRequest) ValidateRequest(request httpcontract.FormRequest) (validatecontract.Errors, error)

+ type GinResponse struct

+ func NewGinResponse(instance *gin.Context, origin httpcontract.ResponseOrigin) *GinResponse

+ func (r *GinResponse) Data(code int, contentType string, data []byte)

+ func (r *GinResponse) Download(filepath, filename string)

+ func (r *GinResponse) File(filepath string)

+ func (r *GinResponse) Header(key, value string) httpcontract.Response

+ func (r *GinResponse) Json(code int, obj any)

+ func (r *GinResponse) Origin() httpcontract.ResponseOrigin

+ func (r *GinResponse) Redirect(code int, location string)

+ func (r *GinResponse) Status(code int) httpcontract.ResponseStatus

+ func (r *GinResponse) String(code int, format string, values ...any)

+ func (r *GinResponse) Success() httpcontract.ResponseSuccess

+ func (r *GinResponse) Writer() http.ResponseWriter

+ type GinRoute struct

+ func NewGinRoute(config config.Config) *GinRoute

+ func (r *GinRoute) Fallback(handler httpcontract.HandlerFunc)

+ func (r *GinRoute) GlobalMiddleware(middlewares ...httpcontract.Middleware)

+ func (r *GinRoute) Run(host ...string) error

+ func (r *GinRoute) RunTLS(host ...string) error

+ func (r *GinRoute) RunTLSWithCert(host, certFile, keyFile string) error

+ func (r *GinRoute) ServeHTTP(writer http.ResponseWriter, request *http.Request)

+ type GinStatus struct

+ func (r *GinStatus) Data(contentType string, data []byte)

+ func (r *GinStatus) Json(obj any)

+ func (r *GinStatus) String(format string, values ...any)

+ type GinSuccess struct

+ func (r *GinSuccess) Data(contentType string, data []byte)

+ func (r *GinSuccess) Json(obj any)

+ func (r *GinSuccess) String(format string, values ...any)

+ type ServiceProvider struct

+ func (receiver *ServiceProvider) Boot(app foundation.Application)

+ func (receiver *ServiceProvider) Register(app foundation.Application)

v1.0.1

Jun 30, 2023

v1.0.0

Jun 30, 2023

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