gin

package module
v1.1.12 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 4, 2023 License: MIT Imports: 35 Imported by: 0

README

Gin

Doc Go Release Test Report Card Codecov License

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
// 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"
    "github.com/gin-gonic/gin/render"
    "github.com/goravel/gin"
)

"default": "gin",

"drivers": map[string]any{
    "gin": map[string]any{
        "route": func() (route.Route, error) {
            return ginfacades.Route(), nil
        },
        // Optional, default is http/template
        "template": func() (render.HTMLRender, error) {
            return gin.DefaultTemplate()
        },
    },
},

Testing

Run command below to run test:

go test ./...

Documentation

Index

Constants

View Source 
const RouteBinding = "goravel.gin.route"

Variables

View Source 
var (
	App              foundation.Application
	ConfigFacade     config.Config
	LogFacade        log.Log
	ValidationFacade validation.Validation
	ViewFacade       http.View
)

Functions

func Background 

func Background() http.Context

func Cors 

func Cors() http.Middleware

func DefaultTemplate 

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

DefaultTemplate creates a TemplateRender instance with default options.

func NewContext 

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

func NewContextRequest 

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

func NewGinSuccess 

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

func NewGroup 

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

func NewStatus 

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

func NewTemplate 

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

func ResponseMiddleware 

func ResponseMiddleware() contractshttp.Middleware

func Tls 

func Tls() contractshttp.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.ContextRequest

func (*Context) Response 

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

func (*Context) Value 

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

func (*Context) WithValue 

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

type ContextRequest 

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

func (*ContextRequest) AbortWithStatus 

func (r *ContextRequest) AbortWithStatus(code int)

func (*ContextRequest) AbortWithStatusJson 

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

func (*ContextRequest) All 

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

func (*ContextRequest) Bind 

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

func (*ContextRequest) File 

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

func (*ContextRequest) Form 

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

func (*ContextRequest) FullUrl 

func (r *ContextRequest) FullUrl() string

func (*ContextRequest) Header 

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

func (*ContextRequest) Headers 

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

func (*ContextRequest) Host 

func (r *ContextRequest) Host() string

func (*ContextRequest) Input 

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

func (*ContextRequest) InputArray 

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

func (*ContextRequest) InputBool 

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

func (*ContextRequest) InputInt 

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

func (*ContextRequest) InputInt64 

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

func (*ContextRequest) InputMap 

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

func (*ContextRequest) Ip 

func (r *ContextRequest) Ip() string

func (*ContextRequest) Json 

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

func (*ContextRequest) Method 

func (r *ContextRequest) Method() string

func (*ContextRequest) Next 

func (r *ContextRequest) Next()

func (*ContextRequest) Origin 

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

func (*ContextRequest) Path 

func (r *ContextRequest) Path() string

func (*ContextRequest) Queries 

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

func (*ContextRequest) Query 

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

func (*ContextRequest) QueryArray 

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

func (*ContextRequest) QueryBool 

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

func (*ContextRequest) QueryInt 

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

func (*ContextRequest) QueryInt64 

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

func (*ContextRequest) QueryMap 

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

func (*ContextRequest) Route 

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

func (*ContextRequest) RouteInt 

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

func (*ContextRequest) RouteInt64 

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

func (*ContextRequest) Url 

func (r *ContextRequest) Url() string

func (*ContextRequest) Validate 

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

func (*ContextRequest) ValidateRequest 

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

type ContextResponse 

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

func NewContextResponse 

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

func (*ContextResponse) Data 

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

func (*ContextResponse) Download 

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

func (*ContextResponse) File 

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

func (*ContextResponse) Flush 

func (r *ContextResponse) Flush()

func (*ContextResponse) Header 

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

func (*ContextResponse) Json 

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

func (*ContextResponse) Origin 

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

func (*ContextResponse) Redirect 

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

func (*ContextResponse) Status 

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

func (*ContextResponse) String 

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

func (*ContextResponse) Success 

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

func (*ContextResponse) View 

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

func (*ContextResponse) Writer 

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

type DataResponse 

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

func (*DataResponse) Render 

func (r *DataResponse) Render() error

type Delims 

type Delims struct {
	Left  string
	Right string
}

type DownloadResponse 

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

func (*DownloadResponse) Render 

func (r *DownloadResponse) Render() error

type FileResponse 

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

func (*FileResponse) Render 

func (r *FileResponse) Render() error

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.Router

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.Router

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 HtmlResponse 

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

func (*HtmlResponse) Render 

func (r *HtmlResponse) Render() error

type JsonResponse 

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

func (*JsonResponse) Render 

func (r *JsonResponse) Render() error

type RedirectResponse 

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

func (*RedirectResponse) Render 

func (r *RedirectResponse) Render() error

type RenderOptions 

type RenderOptions struct {
	Delims  *Delims
	FuncMap template.FuncMap
}

type Route 

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

func NewRoute 

func NewRoute(config config.Config, parameters map[string]any) (*Route, error)

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) contractshttp.Response

func (*Status) Json 

func (r *Status) Json(obj any) contractshttp.Response

func (*Status) String 

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

type StringResponse 

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

func (*StringResponse) Render 

func (r *StringResponse) Render() error

type Success 

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

func (*Success) Data 

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

func (*Success) Json 

func (r *Success) Json(obj any) contractshttp.Response

func (*Success) String 

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

type View 

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

func NewView 

func NewView(instance *gin.Context) *View

func (*View) First 

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

func (*View) Make 

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

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.