gin

README

Gin

Gin http driver for Goravel.

Version

goravel/gin	goravel/framework
v1.1.x	v1.13.x

Install

1. Add package

go get -u github.com/goravel/gin

1. Register service provider, make sure it is registered first.

// config/app.go
import "github.com/goravel/gin"

"providers": []foundation.ServiceProvider{
    &gin.ServiceProvider{},
    ...
}

1. Add gin config to config/http.go file

// config/http.go
import (
    ginfacades "github.com/goravel/gin/facades"
)

"default": "gin",

"drivers": map[string]any{
    ...
    "gin": map[string]any{
        "context": func() (http.Context, error) {
            return ginfacades.Context(), nil
        },
        "route": func() (route.Engine, error) {
            return ginfacades.Route(), nil
        },
    },
}

Testing

Run command below to run test:

go test ./...

Documentation

Index

• Constants
• Variables
• func Background() http.Context
• func NewContext(ctx *gin.Context) http.Context
• func NewGinStatus(instance *gin.Context, code int) httpcontract.ResponseSuccess
• func NewGinSuccess(instance *gin.Context) httpcontract.ResponseSuccess
• 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) Body() *bytes.Buffer
  • func (w *BodyWriter) Header() http.Header
  • func (w *BodyWriter) Write(b []byte) (int, error)
  • func (w *BodyWriter) WriteString(s string) (int, error)
• type Context
  • 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
  • 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
  • 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
  • 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
  • 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 ServiceProvider
  • func (receiver *ServiceProvider) Boot(app foundation.Application)
  • func (receiver *ServiceProvider) Register(app foundation.Application)
• type Status
  • func (r *Status) Data(contentType string, data []byte)
  • func (r *Status) Json(obj any)
  • func (r *Status) String(format string, values ...any)
• type Success
  • func (r *Success) Data(contentType string, data []byte)
  • func (r *Success) Json(obj any)
  • func (r *Success) String(format string, values ...any)

Constants

const HttpBinding = "goravel.gin.http"

const RouteBinding = "goravel.gin.route"

Variables

var (
	ConfigFacade     config.Config
	LogFacade        log.Log
	ValidationFacade validation.Validation
)

var App foundation.Application

Functions

func Background

func Background() http.Context

func NewContext

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

func NewGinStatus

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

func NewGinSuccess

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

func NewGroup

func NewGroup(instance gin.IRouter, prefix string, originMiddlewares []httpcontract.Middleware, lastMiddlewares []httpcontract.Middleware) route.Route

func NewRequest

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

func ResponseMiddleware

func ResponseMiddleware() httpcontract.Middleware

Types

type BodyWriter

type BodyWriter struct {
	gin.ResponseWriter
	// contains filtered or unexported fields
}

func (*BodyWriter) Body

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

func (*BodyWriter) Header

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

func (*BodyWriter) Write

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

func (*BodyWriter) WriteString

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

type Context

type Context struct {
	// contains filtered or unexported fields
}

func (*Context) Context

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

func (*Context) Deadline

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

func (*Context) Done

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

func (*Context) Err

func (c *Context) Err() error

func (*Context) Instance

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

func (*Context) Request

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

func (*Context) Response

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

func (*Context) Value

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

func (*Context) WithValue

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

type Group

type Group struct {
	// contains filtered or unexported fields
}

func (*Group) Any

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

func (*Group) Delete

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

func (*Group) Get

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

func (*Group) Group

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

func (*Group) Middleware

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

func (*Group) Options

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

func (*Group) Patch

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

func (*Group) Post

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

func (*Group) Prefix

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

func (*Group) Put

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

func (*Group) Resource

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

func (*Group) Static

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

func (*Group) StaticFS

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

func (*Group) StaticFile

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

type Request

type Request struct {
	// contains filtered or unexported fields
}

func (*Request) AbortWithStatus

func (r *Request) AbortWithStatus(code int)

func (*Request) AbortWithStatusJson

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

func (*Request) All

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

func (*Request) Bind

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

func (*Request) File

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

func (*Request) Form

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

func (*Request) FullUrl

func (r *Request) FullUrl() string

func (*Request) Header

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

func (*Request) Headers

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

func (*Request) Host

func (r *Request) Host() string

func (*Request) Input

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

func (*Request) InputBool

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

func (*Request) InputInt

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

func (*Request) InputInt64

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

func (*Request) Ip

func (r *Request) Ip() string

func (*Request) Json

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

func (*Request) Method

func (r *Request) Method() string

func (*Request) Next

func (r *Request) Next()

func (*Request) Origin

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

func (*Request) Path

func (r *Request) Path() string

func (*Request) Queries

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

func (*Request) Query

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

func (*Request) QueryArray

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

func (*Request) QueryBool

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

func (*Request) QueryInt

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

func (*Request) QueryInt64

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

func (*Request) QueryMap

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

func (*Request) Route

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

func (*Request) RouteInt

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

func (*Request) RouteInt64

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

func (*Request) Url

func (r *Request) Url() string

func (*Request) Validate

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

func (*Request) ValidateRequest

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

type Response

type Response struct {
	// contains filtered or unexported fields
}

func NewResponse

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

func (*Response) Data

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

func (*Response) Download

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

func (*Response) File

func (r *Response) File(filepath string)

func (*Response) Header

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

func (*Response) Json

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

func (*Response) Origin

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

func (*Response) Redirect

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

func (*Response) Status

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

func (*Response) String

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

func (*Response) Success

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

func (*Response) Writer

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

type Route

type Route struct {
	route.Route
	// contains filtered or unexported fields
}

func NewRoute

func NewRoute(config config.Config) *Route

func (*Route) Fallback

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

func (*Route) GlobalMiddleware

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

func (*Route) Run

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

func (*Route) RunTLS

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

func (*Route) RunTLSWithCert

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

func (*Route) ServeHTTP

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

type ServiceProvider

type ServiceProvider struct {
}

func (*ServiceProvider) Boot

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

func (*ServiceProvider) Register

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

type Status

type Status struct {
	// contains filtered or unexported fields
}

func (*Status) Data

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

func (*Status) Json

func (r *Status) Json(obj any)

func (*Status) String

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

type Success

type Success struct {
	// contains filtered or unexported fields
}

func (*Success) Data

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

func (*Success) Json

func (r *Success) Json(obj any)

func (*Success) String

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