Movatterモバイル変換

[0]ホーム
URL:

gin

packagemodule
v1.11.0Latest Latest
Warning

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

Go to latest Published: Sep 20, 2025 License:MITImports:41Imported by:175,866

Details

Repository

github.com/gin-gonic/gin

Links

README

Gin Web Framework

Build StatuscodecovGo Report CardGo ReferenceSourcegraphOpen Source HelpersReleaseTODOs

Gin is a web framework written inGo. It features a martini-like API with performance that is up to 40 times faster thanks tohttprouter.If you need performance and good productivity, you will love Gin.

Gin's key features are:

  • Zero allocation router
  • Speed
  • Middleware support
  • Crash-free
  • JSON validation
  • Route grouping
  • Error management
  • Built-in rendering
  • Extensible

Getting started

Prerequisites

Gin requiresGo version1.23 or above.

Getting Gin

WithGo's module support,go [build|run|test] automatically fetches the necessary dependencies when you add the import in your code:

import "github.com/gin-gonic/gin"

Alternatively, usego get:

go get -u github.com/gin-gonic/gin
Running Gin

A basic example:

package mainimport (  "net/http"  "github.com/gin-gonic/gin")func main() {  r := gin.Default()  r.GET("/ping", func(c *gin.Context) {    c.JSON(http.StatusOK, gin.H{      "message": "pong",    })  })  r.Run() // listen and serve on 0.0.0.0:8080 (for windows "localhost:8080")}

To run the code, use thego run command, like:

go run example.go

Then visit0.0.0.0:8080/ping in your browser to see the response!

See more examples
Quick Start

Learn and practice with theGin Quick Start, which includes API examples and builds tag.

Examples

A number of ready-to-run examples demonstrating various use cases of Gin are available in theGin examples repository.

Documentation

See theAPI documentation on go.dev.

The documentation is also available ongin-gonic.com in several languages:

Articles

Benchmarks

Gin uses a custom version ofHttpRouter,see all benchmarks.

Benchmark name(1)(2)(3)(4)
BenchmarkGin_GithubAll4355027364 ns/op0 B/op0 allocs/op
BenchmarkAce_GithubAll4054329670 ns/op0 B/op0 allocs/op
BenchmarkAero_GithubAll5763220648 ns/op0 B/op0 allocs/op
BenchmarkBear_GithubAll9234216179 ns/op86448 B/op943 allocs/op
BenchmarkBeego_GithubAll7407243496 ns/op71456 B/op609 allocs/op
BenchmarkBone_GithubAll4202922835 ns/op720160 B/op8620 allocs/op
BenchmarkChi_GithubAll7620238331 ns/op87696 B/op609 allocs/op
BenchmarkDenco_GithubAll1835564494 ns/op20224 B/op167 allocs/op
BenchmarkEcho_GithubAll3125138479 ns/op0 B/op0 allocs/op
BenchmarkGocraftWeb_GithubAll4117300062 ns/op131656 B/op1686 allocs/op
BenchmarkGoji_GithubAll3274416158 ns/op56112 B/op334 allocs/op
BenchmarkGojiv2_GithubAll1402870518 ns/op352720 B/op4321 allocs/op
BenchmarkGoJsonRest_GithubAll2976401507 ns/op134371 B/op2737 allocs/op
BenchmarkGoRestful_GithubAll4102913158 ns/op910144 B/op2938 allocs/op
BenchmarkGorillaMux_GithubAll3463384987 ns/op251650 B/op1994 allocs/op
BenchmarkGowwwRouter_GithubAll10000143025 ns/op72144 B/op501 allocs/op
BenchmarkHttpRouter_GithubAll5593821360 ns/op0 B/op0 allocs/op
BenchmarkHttpTreeMux_GithubAll10000153944 ns/op65856 B/op671 allocs/op
BenchmarkKocha_GithubAll10000106315 ns/op23304 B/op843 allocs/op
BenchmarkLARS_GithubAll4777925084 ns/op0 B/op0 allocs/op
BenchmarkMacaron_GithubAll3266371907 ns/op149409 B/op1624 allocs/op
BenchmarkMartini_GithubAll3313444706 ns/op226551 B/op2325 allocs/op
BenchmarkPat_GithubAll2734381818 ns/op1483152 B/op26963 allocs/op
BenchmarkPossum_GithubAll10000164367 ns/op84448 B/op609 allocs/op
BenchmarkR2router_GithubAll10000160220 ns/op77328 B/op979 allocs/op
BenchmarkRivet_GithubAll1462582453 ns/op16272 B/op167 allocs/op
BenchmarkTango_GithubAll6255279611 ns/op63826 B/op1618 allocs/op
BenchmarkTigerTonic_GithubAll2008687874 ns/op193856 B/op4474 allocs/op
BenchmarkTraffic_GithubAll3553478508 ns/op820744 B/op14114 allocs/op
BenchmarkVulcan_GithubAll6885193333 ns/op19894 B/op609 allocs/op
  • (1): Total Repetitions achieved in constant time, higher means more confident result
  • (2): Single Repetition Duration (ns/op), lower is better
  • (3): Heap Memory (B/op), lower is better
  • (4): Average Allocations per Repetition (allocs/op), lower is better

Middleware

You can find many useful Gin middlewares atgin-contrib andgin-gonic/contrib.

Uses

Here are some awesome projects that are using theGin web framework.

  • gorush: A push notification server.
  • fnproject: A container native, cloud agnostic serverless platform.
  • photoprism: Personal photo management powered by Google TensorFlow.
  • lura: Ultra performant API Gateway with middleware.
  • picfit: An image resizing server.
  • dkron: Distributed, fault tolerant job scheduling system.

Contributing

Gin is the work of hundreds of contributors. We appreciate your help!

Please seeCONTRIBUTING.md for details on submitting patches and the contribution workflow.

Documentation

Overview

Package gin implements a HTTP web framework called gin.

Seehttps://gin-gonic.com/ for more information about gin.

Example:

package mainimport "github.com/gin-gonic/gin"func main() {r := gin.Default()r.GET("/ping", func(c *gin.Context) {c.JSON(200, gin.H{"message": "pong",})})r.Run() // listen and serve on 0.0.0.0:8080}

Index

Constants

View Source
const (MIMEJSON              =binding.MIMEJSONMIMEHTML              =binding.MIMEHTMLMIMEXML               =binding.MIMEXMLMIMEXML2              =binding.MIMEXML2MIMEPlain             =binding.MIMEPlainMIMEPOSTForm          =binding.MIMEPOSTFormMIMEMultipartPOSTForm =binding.MIMEMultipartPOSTFormMIMEYAML              =binding.MIMEYAMLMIMEYAML2             =binding.MIMEYAML2MIMETOML              =binding.MIMETOML)

Content-Type MIME of the most common data formats.

View Source
const (// PlatformGoogleAppEngine when running on Google App Engine. Trust X-Appengine-Remote-Addr// for determining the client's IPPlatformGoogleAppEngine = "X-Appengine-Remote-Addr"// PlatformCloudflare when using Cloudflare's CDN. Trust CF-Connecting-IP for determining// the client's IPPlatformCloudflare = "CF-Connecting-IP"// PlatformFlyIO when running on Fly.io. Trust Fly-Client-IP for determining the client's IPPlatformFlyIO = "Fly-Client-IP")

Trusted platforms

View Source
const (// DebugMode indicates gin mode is debug.DebugMode = "debug"// ReleaseMode indicates gin mode is release.ReleaseMode = "release"// TestMode indicates gin mode is test.TestMode = "test")
View Source
const AuthProxyUserKey = "proxy_user"

AuthProxyUserKey is the cookie name for proxy_user credential in basic auth for proxy.

View Source
const AuthUserKey = "user"

AuthUserKey is the cookie name for user credential in basic auth.

View Source
const BindKey = "_gin-gonic/gin/bindkey"

BindKey indicates a default bind key.

View Source
const BodyBytesKey = "_gin-gonic/gin/bodybyteskey"

BodyBytesKey indicates a default body bytes key.

View Source
const ContextKey = "_gin-gonic/gin/contextkey"

ContextKey is the key that a Context returns itself for.

View Source
const EnvGinMode = "GIN_MODE"

EnvGinMode indicates environment name for gin mode.

View Source
const Version = "v1.11.0"

Version is the current gin framework's version.

Variables

View Source
var DebugPrintFunc func(formatstring, values ...any)

DebugPrintFunc indicates debug log output format.

View Source
var DebugPrintRouteFunc func(httpMethod, absolutePath, handlerNamestring, nuHandlersint)

DebugPrintRouteFunc indicates debug log output format.

View Source
var DefaultErrorWriterio.Writer =os.Stderr

DefaultErrorWriter is the default io.Writer used by Gin to debug errors

View Source
var DefaultWriterio.Writer =os.Stdout

DefaultWriter is the default io.Writer used by Gin for debug output andmiddleware output like Logger() or Recovery().Note that both Logger and Recovery provides custom ways to configure theiroutput io.Writer.To support coloring in Windows use:

import "github.com/mattn/go-colorable"gin.DefaultWriter = colorable.NewColorableStdout()

Functions

funcCreateTestContextadded inv1.3.0

func CreateTestContext(whttp.ResponseWriter) (c *Context, r *Engine)

CreateTestContext returns a fresh Engine and a Context associated with it.This is useful for tests that need to set up a new Gin engine instancealong with a context, for example, to test middleware that doesn't depend onspecific routes. The ResponseWriter `w` is used to initialize the context's writer.

funcDir

func Dir(rootstring, listDirectorybool)http.FileSystem

Dir returns an http.FileSystem that can be used by http.FileServer().It is used internally in router.Static().if listDirectory == true, then it works the same as http.Dir(),otherwise it returns a filesystem that prevents http.FileServer() to list the directory files.

funcDisableBindValidation

func DisableBindValidation()

DisableBindValidation closes the default validator.

funcDisableConsoleColoradded inv1.3.0

func DisableConsoleColor()

DisableConsoleColor disables color output in the console.

funcEnableJsonDecoderDisallowUnknownFieldsadded inv1.5.0

func EnableJsonDecoderDisallowUnknownFields()

EnableJsonDecoderDisallowUnknownFields sets true for binding.EnableDecoderDisallowUnknownFields tocall the DisallowUnknownFields method on the JSON Decoder instance.

funcEnableJsonDecoderUseNumberadded inv1.3.0

func EnableJsonDecoderUseNumber()

EnableJsonDecoderUseNumber sets true for binding.EnableDecoderUseNumber tocall the UseNumber method on the JSON Decoder instance.

funcForceConsoleColoradded inv1.4.0

func ForceConsoleColor()

ForceConsoleColor force color output in the console.

funcIsDebugging

func IsDebugging()bool

IsDebugging returns true if the framework is running in debug mode.Use SetMode(gin.ReleaseMode) to disable debug mode.

funcMode

func Mode()string

Mode returns current gin mode.

funcSetMode

func SetMode(valuestring)

SetMode sets gin mode according to input string.

Types

typeAccounts

type Accounts map[string]string

Accounts defines a key/value for user/pass list of authorized logins.

typeContext

type Context struct {Request *http.RequestWriterResponseWriterParamsParams// Keys is a key/value pair exclusively for the context of each request.Keys map[any]any// Errors is a list of errors attached to all the handlers/middlewares who used this context.Errors errorMsgs// Accepted defines a list of manually accepted formats for content negotiation.Accepted []string// contains filtered or unexported fields}

Context is the most important part of gin. It allows us to pass variables between middleware,manage the flow, validate the JSON of a request and render a JSON response for example.

funcCreateTestContextOnlyadded inv1.8.2

func CreateTestContextOnly(whttp.ResponseWriter, r *Engine) (c *Context)

CreateTestContextOnly returns a fresh Context associated with the provided Engine `r`.This is useful for tests that operate on an existing, possibly pre-configured,Gin engine instance and need a new context for it.The ResponseWriter `w` is used to initialize the context's writer.The context is allocated with the `maxParams` setting from the provided engine.

func (*Context)Abort

func (c *Context) Abort()

Abort prevents pending handlers from being called. Note that this will not stop the current handler.Let's say you have an authorization middleware that validates that the current request is authorized.If the authorization fails (ex: the password does not match), call Abort to ensure the remaining handlersfor this request are not called.

func (*Context)AbortWithError

func (c *Context) AbortWithError(codeint, errerror) *Error

AbortWithError calls `AbortWithStatus()` and `Error()` internally.This method stops the chain, writes the status code and pushes the specified error to `c.Errors`.See Context.Error() for more details.

func (*Context)AbortWithStatus

func (c *Context) AbortWithStatus(codeint)

AbortWithStatus calls `Abort()` and writes the headers with the specified status code.For example, a failed attempt to authenticate a request could use: context.AbortWithStatus(401).

func (*Context)AbortWithStatusJSONadded inv1.3.0

func (c *Context) AbortWithStatusJSON(codeint, jsonObjany)

AbortWithStatusJSON calls `Abort()` and then `JSON` internally.This method stops the chain, writes the status code and return a JSON body.It also sets the Content-Type as "application/json".

func (*Context)AbortWithStatusPureJSONadded inv1.11.0

func (c *Context) AbortWithStatusPureJSON(codeint, jsonObjany)

AbortWithStatusPureJSON calls `Abort()` and then `PureJSON` internally.This method stops the chain, writes the status code and return a JSON body without escaping.It also sets the Content-Type as "application/json".

func (*Context)AddParamadded inv1.8.0

func (c *Context) AddParam(key, valuestring)

AddParam adds param to context andreplaces path param key with given value for e2e testing purposesExample Route: "/user/:id"AddParam("id", 1)Result: "/user/1"

func (*Context)AsciiJSONadded inv1.3.0

func (c *Context) AsciiJSON(codeint, objany)

AsciiJSON serializes the given struct as JSON into the response body with unicode to ASCII string.It also sets the Content-Type as "application/json".

func (*Context)Bind

func (c *Context) Bind(objany)error

Bind checks the Method and Content-Type to select a binding engine automatically,Depending on the "Content-Type" header different bindings are used, for example:

"application/json" --> JSON binding"application/xml"  --> XML binding

It parses the request's body as JSON if Content-Type == "application/json" using JSON or XML as a JSON input.It decodes the json payload into the struct specified as a pointer.It writes a 400 error and sets Content-Type header "text/plain" in the response if input is not valid.

func (*Context)BindHeaderadded inv1.5.0

func (c *Context) BindHeader(objany)error

BindHeader is a shortcut for c.MustBindWith(obj, binding.Header).

func (*Context)BindJSON

func (c *Context) BindJSON(objany)error

BindJSON is a shortcut for c.MustBindWith(obj, binding.JSON).

func (*Context)BindPlainadded inv1.11.0

func (c *Context) BindPlain(objany)error

BindPlain is a shortcut for c.MustBindWith(obj, binding.Plain).

func (*Context)BindQueryadded inv1.3.0

func (c *Context) BindQuery(objany)error

BindQuery is a shortcut for c.MustBindWith(obj, binding.Query).

func (*Context)BindTOMLadded inv1.8.0

func (c *Context) BindTOML(objany)error

BindTOML is a shortcut for c.MustBindWith(obj, binding.TOML).

func (*Context)BindUriadded inv1.4.0

func (c *Context) BindUri(objany)error

BindUri binds the passed struct pointer using binding.Uri.It will abort the request with HTTP 400 if any error occurs.

func (*Context)BindWithdeprecated

func (c *Context) BindWith(objany, bbinding.Binding)error

BindWith binds the passed struct pointer using the specified binding engine.See the binding package.

Deprecated: Use MustBindWith or ShouldBindWith.

func (*Context)BindXMLadded inv1.4.0

func (c *Context) BindXML(objany)error

BindXML is a shortcut for c.MustBindWith(obj, binding.BindXML).

func (*Context)BindYAMLadded inv1.4.0

func (c *Context) BindYAML(objany)error

BindYAML is a shortcut for c.MustBindWith(obj, binding.YAML).

func (*Context)ClientIP

func (c *Context) ClientIP()string

ClientIP implements one best effort algorithm to return the real client IP.It calls c.RemoteIP() under the hood, to check if the remote IP is a trusted proxy or not.If it is it will then try to parse the headers defined in Engine.RemoteIPHeaders (defaulting to [X-Forwarded-For, X-Real-IP]).If the headers are not syntactically valid OR the remote IP does not correspond to a trusted proxy,the remote IP (coming from Request.RemoteAddr) is returned.

func (*Context)ContentType

func (c *Context) ContentType()string

ContentType returns the Content-Type header of the request.

func (*Context)Cookie

func (c *Context) Cookie(namestring) (string,error)

Cookie returns the named cookie provided in the request orErrNoCookie if not found. And return the named cookie is unescaped.If multiple cookies match the given name, only one cookie willbe returned.

func (*Context)Copy

func (c *Context) Copy() *Context

Copy returns a copy of the current context that can be safely used outside the request's scope.This has to be used when the context has to be passed to a goroutine.

func (*Context)Data

func (c *Context) Data(codeint, contentTypestring, data []byte)

Data writes some data into the body stream and updates the HTTP code.

func (*Context)DataFromReaderadded inv1.3.0

func (c *Context) DataFromReader(codeint, contentLengthint64, contentTypestring, readerio.Reader, extraHeaders map[string]string)

DataFromReader writes the specified reader into the body stream and updates the HTTP code.

func (*Context)Deadline

func (c *Context) Deadline() (deadlinetime.Time, okbool)

Deadline returns that there is no deadline (ok==false) when c.Request has no Context.

func (*Context)DefaultPostForm

func (c *Context) DefaultPostForm(key, defaultValuestring)string

DefaultPostForm returns the specified key from a POST urlencoded form or multipart formwhen it exists, otherwise it returns the specified defaultValue string.See: PostForm() and GetPostForm() for further information.

func (*Context)DefaultQuery

func (c *Context) DefaultQuery(key, defaultValuestring)string

DefaultQuery returns the keyed url query value if it exists,otherwise it returns the specified defaultValue string.See: Query() and GetQuery() for further information.

GET /?name=Manu&lastname=c.DefaultQuery("name", "unknown") == "Manu"c.DefaultQuery("id", "none") == "none"c.DefaultQuery("lastname", "none") == ""

func (*Context)Done

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

Done returns nil (chan which will wait forever) when c.Request has no Context.

func (*Context)Err

func (c *Context) Err()error

Err returns nil when c.Request has no Context.

func (*Context)Error

func (c *Context) Error(errerror) *Error

Error attaches an error to the current context. The error is pushed to a list of errors.It's a good idea to call Error for each error that occurred during the resolution of a request.A middleware can be used to collect all the errors and push them to a database together,print a log, or append it in the HTTP response.Error will panic if err is nil.

func (*Context)File

func (c *Context) File(filepathstring)

File writes the specified file into the body stream in an efficient way.

func (*Context)FileAttachmentadded inv1.4.0

func (c *Context) FileAttachment(filepath, filenamestring)

FileAttachment writes the specified file into the body stream in an efficient wayOn the client side, the file will typically be downloaded with the given filename

func (*Context)FileFromFSadded inv1.6.0

func (c *Context) FileFromFS(filepathstring, fshttp.FileSystem)

FileFromFS writes the specified file from http.FileSystem into the body stream in an efficient way.

func (*Context)FormFileadded inv1.3.0

func (c *Context) FormFile(namestring) (*multipart.FileHeader,error)

FormFile returns the first file for the provided form key.

func (*Context)FullPathadded inv1.5.0

func (c *Context) FullPath()string

FullPath returns a matched route full path. For not found routesreturns an empty string.

router.GET("/user/:id", func(c *gin.Context) {    c.FullPath() == "/user/:id" // true})

func (*Context)Get

func (c *Context) Get(keyany) (valueany, existsbool)

Get returns the value for the given key, ie: (value, true).If the value does not exist it returns (nil, false)

func (*Context)GetBooladded inv1.3.0

func (c *Context) GetBool(keyany) (bbool)

GetBool returns the value associated with the key as a boolean.

func (*Context)GetDurationadded inv1.3.0

func (c *Context) GetDuration(keyany) (dtime.Duration)

GetDuration returns the value associated with the key as a duration.

func (*Context)GetFloat32added inv1.11.0

func (c *Context) GetFloat32(keyany) (f32float32)

GetFloat32 returns the value associated with the key as a float32.

func (*Context)GetFloat32Sliceadded inv1.11.0

func (c *Context) GetFloat32Slice(keyany) (f32s []float32)

GetFloat32Slice returns the value associated with the key as a slice of float32 numbers.

func (*Context)GetFloat64added inv1.3.0

func (c *Context) GetFloat64(keyany) (f64float64)

GetFloat64 returns the value associated with the key as a float64.

func (*Context)GetFloat64Sliceadded inv1.11.0

func (c *Context) GetFloat64Slice(keyany) (f64s []float64)

GetFloat64Slice returns the value associated with the key as a slice of float64 numbers.

func (*Context)GetHeaderadded inv1.3.0

func (c *Context) GetHeader(keystring)string

GetHeader returns value from request headers.

func (*Context)GetIntadded inv1.3.0

func (c *Context) GetInt(keyany) (iint)

GetInt returns the value associated with the key as an integer.

func (*Context)GetInt16added inv1.11.0

func (c *Context) GetInt16(keyany) (i16int16)

GetInt16 returns the value associated with the key as an integer 16.

func (*Context)GetInt16Sliceadded inv1.11.0

func (c *Context) GetInt16Slice(keyany) (i16s []int16)

GetInt16Slice returns the value associated with the key as a slice of int16 integers.

func (*Context)GetInt32added inv1.11.0

func (c *Context) GetInt32(keyany) (i32int32)

GetInt32 returns the value associated with the key as an integer 32.

func (*Context)GetInt32Sliceadded inv1.11.0

func (c *Context) GetInt32Slice(keyany) (i32s []int32)

GetInt32Slice returns the value associated with the key as a slice of int32 integers.

func (*Context)GetInt64added inv1.3.0

func (c *Context) GetInt64(keyany) (i64int64)

GetInt64 returns the value associated with the key as an integer 64.

func (*Context)GetInt64Sliceadded inv1.11.0

func (c *Context) GetInt64Slice(keyany) (i64s []int64)

GetInt64Slice returns the value associated with the key as a slice of int64 integers.

func (*Context)GetInt8added inv1.11.0

func (c *Context) GetInt8(keyany) (i8int8)

GetInt8 returns the value associated with the key as an integer 8.

func (*Context)GetInt8Sliceadded inv1.11.0

func (c *Context) GetInt8Slice(keyany) (i8s []int8)

GetInt8Slice returns the value associated with the key as a slice of int8 integers.

func (*Context)GetIntSliceadded inv1.11.0

func (c *Context) GetIntSlice(keyany) (is []int)

GetIntSlice returns the value associated with the key as a slice of integers.

func (*Context)GetPostForm

func (c *Context) GetPostForm(keystring) (string,bool)

GetPostForm is like PostForm(key). It returns the specified key from a POST urlencodedform or multipart form when it exists `(value, true)` (even when the value is an empty string),otherwise it returns ("", false).For example, during a PATCH request to update the user's email:

    email=mail@example.com  -->  ("mail@example.com", true) := GetPostForm("email") // set email to "mail@example.com"   email=                  -->  ("", true) := GetPostForm("email") // set email to ""                            -->  ("", false) := GetPostForm("email") // do nothing with email

func (*Context)GetPostFormArray

func (c *Context) GetPostFormArray(keystring) (values []string, okbool)

GetPostFormArray returns a slice of strings for a given form key, plusa boolean value whether at least one value exists for the given key.

func (*Context)GetPostFormMapadded inv1.3.0

func (c *Context) GetPostFormMap(keystring) (map[string]string,bool)

GetPostFormMap returns a map for a given form key, plus a boolean valuewhether at least one value exists for the given key.

func (*Context)GetQuery

func (c *Context) GetQuery(keystring) (string,bool)

GetQuery is like Query(), it returns the keyed url query valueif it exists `(value, true)` (even when the value is an empty string),otherwise it returns `("", false)`.It is shortcut for `c.Request.URL.Query().Get(key)`

GET /?name=Manu&lastname=("Manu", true) == c.GetQuery("name")("", false) == c.GetQuery("id")("", true) == c.GetQuery("lastname")

func (*Context)GetQueryArray

func (c *Context) GetQueryArray(keystring) (values []string, okbool)

GetQueryArray returns a slice of strings for a given query key, plusa boolean value whether at least one value exists for the given key.

func (*Context)GetQueryMapadded inv1.3.0

func (c *Context) GetQueryMap(keystring) (map[string]string,bool)

GetQueryMap returns a map for a given query key, plus a boolean valuewhether at least one value exists for the given key.

func (*Context)GetRawDataadded inv1.3.0

func (c *Context) GetRawData() ([]byte,error)

GetRawData returns stream data.

func (*Context)GetStringadded inv1.3.0

func (c *Context) GetString(keyany) (sstring)

GetString returns the value associated with the key as a string.

func (*Context)GetStringMapadded inv1.3.0

func (c *Context) GetStringMap(keyany) (sm map[string]any)

GetStringMap returns the value associated with the key as a map of interfaces.

func (*Context)GetStringMapStringadded inv1.3.0

func (c *Context) GetStringMapString(keyany) (sms map[string]string)

GetStringMapString returns the value associated with the key as a map of strings.

func (*Context)GetStringMapStringSliceadded inv1.3.0

func (c *Context) GetStringMapStringSlice(keyany) (smss map[string][]string)

GetStringMapStringSlice returns the value associated with the key as a map to a slice of strings.

func (*Context)GetStringSliceadded inv1.3.0

func (c *Context) GetStringSlice(keyany) (ss []string)

GetStringSlice returns the value associated with the key as a slice of strings.

func (*Context)GetTimeadded inv1.3.0

func (c *Context) GetTime(keyany) (ttime.Time)

GetTime returns the value associated with the key as time.

func (*Context)GetUintadded inv1.7.0

func (c *Context) GetUint(keyany) (uiuint)

GetUint returns the value associated with the key as an unsigned integer.

func (*Context)GetUint16added inv1.11.0

func (c *Context) GetUint16(keyany) (ui16uint16)

GetUint16 returns the value associated with the key as an unsigned integer 16.

func (*Context)GetUint16Sliceadded inv1.11.0

func (c *Context) GetUint16Slice(keyany) (ui16s []uint16)

GetUint16Slice returns the value associated with the key as a slice of uint16 integers.

func (*Context)GetUint32added inv1.11.0

func (c *Context) GetUint32(keyany) (ui32uint32)

GetUint32 returns the value associated with the key as an unsigned integer 32.

func (*Context)GetUint32Sliceadded inv1.11.0

func (c *Context) GetUint32Slice(keyany) (ui32s []uint32)

GetUint32Slice returns the value associated with the key as a slice of uint32 integers.

func (*Context)GetUint64added inv1.7.0

func (c *Context) GetUint64(keyany) (ui64uint64)

GetUint64 returns the value associated with the key as an unsigned integer 64.

func (*Context)GetUint64Sliceadded inv1.11.0

func (c *Context) GetUint64Slice(keyany) (ui64s []uint64)

GetUint64Slice returns the value associated with the key as a slice of uint64 integers.

func (*Context)GetUint8added inv1.11.0

func (c *Context) GetUint8(keyany) (ui8uint8)

GetUint8 returns the value associated with the key as an unsigned integer 8.

func (*Context)GetUint8Sliceadded inv1.11.0

func (c *Context) GetUint8Slice(keyany) (ui8s []uint8)

GetUint8Slice returns the value associated with the key as a slice of uint8 integers.

func (*Context)GetUintSliceadded inv1.11.0

func (c *Context) GetUintSlice(keyany) (uis []uint)

GetUintSlice returns the value associated with the key as a slice of unsigned integers.

func (*Context)HTML

func (c *Context) HTML(codeint, namestring, objany)

HTML renders the HTTP template specified by its file name.It also updates the HTTP code and sets the Content-Type as "text/html".Seehttp://golang.org/doc/articles/wiki/

func (*Context)Handleradded inv1.3.0

func (c *Context) Handler()HandlerFunc

Handler returns the main handler.

func (*Context)HandlerName

func (c *Context) HandlerName()string

HandlerName returns the main handler's name. For example if the handler is "handleGetUsers()",this function will return "main.handleGetUsers".

func (*Context)HandlerNamesadded inv1.4.0

func (c *Context) HandlerNames() []string

HandlerNames returns a list of all registered handlers for this context in descending order,following the semantics of HandlerName()

func (*Context)Header

func (c *Context) Header(key, valuestring)

Header is an intelligent shortcut for c.Writer.Header().Set(key, value).It writes a header in the response.If value == "", this method removes the header `c.Writer.Header().Del(key)`

func (*Context)IndentedJSON

func (c *Context) IndentedJSON(codeint, objany)

IndentedJSON serializes the given struct as pretty JSON (indented + endlines) into the response body.It also sets the Content-Type as "application/json".WARNING: we recommend using this only for development purposes since printing pretty JSON ismore CPU and bandwidth consuming. Use Context.JSON() instead.

func (*Context)IsAborted

func (c *Context) IsAborted()bool

IsAborted returns true if the current context was aborted.

func (*Context)IsWebsocketadded inv1.3.0

func (c *Context) IsWebsocket()bool

IsWebsocket returns true if the request headers indicate that a websockethandshake is being initiated by the client.

func (*Context)JSON

func (c *Context) JSON(codeint, objany)

JSON serializes the given struct as JSON into the response body.It also sets the Content-Type as "application/json".

func (*Context)JSONPadded inv1.3.0

func (c *Context) JSONP(codeint, objany)

JSONP serializes the given struct as JSON into the response body.It adds padding to response body to request data from a server residing in a different domain than the client.It also sets the Content-Type as "application/javascript".

func (*Context)MultipartFormadded inv1.3.0

func (c *Context) MultipartForm() (*multipart.Form,error)

MultipartForm is the parsed multipart form, including file uploads.

func (*Context)MustBindWithadded inv1.3.0

func (c *Context) MustBindWith(objany, bbinding.Binding)error

MustBindWith binds the passed struct pointer using the specified binding engine.It will abort the request with HTTP 400 if any error occurs.See the binding package.

func (*Context)MustGet

func (c *Context) MustGet(keyany)any

MustGet returns the value for the given key if it exists, otherwise it panics.

func (*Context)Negotiate

func (c *Context) Negotiate(codeint, configNegotiate)

Negotiate calls different Render according to acceptable Accept format.

func (*Context)NegotiateFormat

func (c *Context) NegotiateFormat(offered ...string)string

NegotiateFormat returns an acceptable Accept format.

func (*Context)Next

func (c *Context) Next()

Next should be used only inside middleware.It executes the pending handlers in the chain inside the calling handler.See example in GitHub.

func (*Context)Param

func (c *Context) Param(keystring)string

Param returns the value of the URL param.It is a shortcut for c.Params.ByName(key)

router.GET("/user/:id", func(c *gin.Context) {    // a GET request to /user/john    id := c.Param("id") // id == "john"    // a GET request to /user/john/    id := c.Param("id") // id == "/john/"})

func (*Context)PostForm

func (c *Context) PostForm(keystring) (valuestring)

PostForm returns the specified key from a POST urlencoded form or multipart formwhen it exists, otherwise it returns an empty string `("")`.

func (*Context)PostFormArray

func (c *Context) PostFormArray(keystring) (values []string)

PostFormArray returns a slice of strings for a given form key.The length of the slice depends on the number of params with the given key.

func (*Context)PostFormMapadded inv1.3.0

func (c *Context) PostFormMap(keystring) (dicts map[string]string)

PostFormMap returns a map for a given form key.

func (*Context)ProtoBufadded inv1.4.0

func (c *Context) ProtoBuf(codeint, objany)

ProtoBuf serializes the given struct as ProtoBuf into the response body.

func (*Context)PureJSONadded inv1.4.0

func (c *Context) PureJSON(codeint, objany)

PureJSON serializes the given struct as JSON into the response body.PureJSON, unlike JSON, does not replace special html characters with their unicode entities.

func (*Context)Query

func (c *Context) Query(keystring) (valuestring)

Query returns the keyed url query value if it exists,otherwise it returns an empty string `("")`.It is shortcut for `c.Request.URL.Query().Get(key)`

    GET /path?id=1234&name=Manu&value=   c.Query("id") == "1234"   c.Query("name") == "Manu"   c.Query("value") == ""   c.Query("wtf") == ""

func (*Context)QueryArray

func (c *Context) QueryArray(keystring) (values []string)

QueryArray returns a slice of strings for a given query key.The length of the slice depends on the number of params with the given key.

func (*Context)QueryMapadded inv1.3.0

func (c *Context) QueryMap(keystring) (dicts map[string]string)

QueryMap returns a map for a given query key.

func (*Context)Redirect

func (c *Context) Redirect(codeint, locationstring)

Redirect returns an HTTP redirect to the specific location.

func (*Context)RemoteIPadded inv1.7.0

func (c *Context) RemoteIP()string

RemoteIP parses the IP from Request.RemoteAddr, normalizes and returns the IP (without the port).

func (*Context)Render

func (c *Context) Render(codeint, rrender.Render)

Render writes the response headers and calls render.Render to render data.

func (*Context)SSEvent

func (c *Context) SSEvent(namestring, messageany)

SSEvent writes a Server-Sent Event into the body stream.

func (*Context)SaveUploadedFileadded inv1.3.0

func (c *Context) SaveUploadedFile(file *multipart.FileHeader, dststring, perm ...fs.FileMode)error

SaveUploadedFile uploads the form file to specific dst.

func (*Context)SecureJSONadded inv1.3.0

func (c *Context) SecureJSON(codeint, objany)

SecureJSON serializes the given struct as Secure JSON into the response body.Default prepends "while(1)," to response body if the given struct is array values.It also sets the Content-Type as "application/json".

func (*Context)Set

func (c *Context) Set(keyany, valueany)

Set is used to store a new key/value pair exclusively for this context.It also lazy initializes c.Keys if it was not used previously.

func (*Context)SetAccepted

func (c *Context) SetAccepted(formats ...string)

SetAccepted sets Accept header data.

func (*Context)SetCookie

func (c *Context) SetCookie(name, valuestring, maxAgeint, path, domainstring, secure, httpOnlybool)

SetCookie adds a Set-Cookie header to the ResponseWriter's headers.The provided cookie must have a valid Name. Invalid cookies may besilently dropped.

func (*Context)SetCookieDataadded inv1.11.0

func (c *Context) SetCookieData(cookie *http.Cookie)

SetCookieData adds a Set-Cookie header to the ResponseWriter's headers.It accepts a pointer to http.Cookie structure for more flexibility in setting cookie attributes.The provided cookie must have a valid Name. Invalid cookies may be silently dropped.

func (*Context)SetSameSiteadded inv1.6.2

func (c *Context) SetSameSite(samesitehttp.SameSite)

SetSameSite with cookie

func (*Context)ShouldBindadded inv1.3.0

func (c *Context) ShouldBind(objany)error

ShouldBind checks the Method and Content-Type to select a binding engine automatically,Depending on the "Content-Type" header different bindings are used, for example:

"application/json" --> JSON binding"application/xml"  --> XML binding

It parses the request's body as JSON if Content-Type == "application/json" using JSON or XML as a JSON input.It decodes the json payload into the struct specified as a pointer.Like c.Bind() but this method does not set the response status code to 400 or abort if input is not valid.

func (*Context)ShouldBindBodyWithadded inv1.3.0

func (c *Context) ShouldBindBodyWith(objany, bbbinding.BindingBody) (errerror)

ShouldBindBodyWith is similar with ShouldBindWith, but it stores the requestbody into the context, and reuse when it is called again.

NOTE: This method reads the body before binding. So you should useShouldBindWith for better performance if you need to call only once.

func (*Context)ShouldBindBodyWithJSONadded inv1.10.0

func (c *Context) ShouldBindBodyWithJSON(objany)error

ShouldBindBodyWithJSON is a shortcut for c.ShouldBindBodyWith(obj, binding.JSON).

func (*Context)ShouldBindBodyWithPlainadded inv1.11.0

func (c *Context) ShouldBindBodyWithPlain(objany)error

ShouldBindBodyWithPlain is a shortcut for c.ShouldBindBodyWith(obj, binding.Plain).

func (*Context)ShouldBindBodyWithTOMLadded inv1.10.0

func (c *Context) ShouldBindBodyWithTOML(objany)error

ShouldBindBodyWithTOML is a shortcut for c.ShouldBindBodyWith(obj, binding.TOML).

func (*Context)ShouldBindBodyWithXMLadded inv1.10.0

func (c *Context) ShouldBindBodyWithXML(objany)error

ShouldBindBodyWithXML is a shortcut for c.ShouldBindBodyWith(obj, binding.XML).

func (*Context)ShouldBindBodyWithYAMLadded inv1.10.0

func (c *Context) ShouldBindBodyWithYAML(objany)error

ShouldBindBodyWithYAML is a shortcut for c.ShouldBindBodyWith(obj, binding.YAML).

func (*Context)ShouldBindHeaderadded inv1.5.0

func (c *Context) ShouldBindHeader(objany)error

ShouldBindHeader is a shortcut for c.ShouldBindWith(obj, binding.Header).

func (*Context)ShouldBindJSONadded inv1.3.0

func (c *Context) ShouldBindJSON(objany)error

ShouldBindJSON is a shortcut for c.ShouldBindWith(obj, binding.JSON).

func (*Context)ShouldBindPlainadded inv1.11.0

func (c *Context) ShouldBindPlain(objany)error

ShouldBindPlain is a shortcut for c.ShouldBindWith(obj, binding.Plain).

func (*Context)ShouldBindQueryadded inv1.3.0

func (c *Context) ShouldBindQuery(objany)error

ShouldBindQuery is a shortcut for c.ShouldBindWith(obj, binding.Query).

func (*Context)ShouldBindTOMLadded inv1.8.0

func (c *Context) ShouldBindTOML(objany)error

ShouldBindTOML is a shortcut for c.ShouldBindWith(obj, binding.TOML).

func (*Context)ShouldBindUriadded inv1.4.0

func (c *Context) ShouldBindUri(objany)error

ShouldBindUri binds the passed struct pointer using the specified binding engine.

func (*Context)ShouldBindWithadded inv1.3.0

func (c *Context) ShouldBindWith(objany, bbinding.Binding)error

ShouldBindWith binds the passed struct pointer using the specified binding engine.See the binding package.

func (*Context)ShouldBindXMLadded inv1.4.0

func (c *Context) ShouldBindXML(objany)error

ShouldBindXML is a shortcut for c.ShouldBindWith(obj, binding.XML).

func (*Context)ShouldBindYAMLadded inv1.4.0

func (c *Context) ShouldBindYAML(objany)error

ShouldBindYAML is a shortcut for c.ShouldBindWith(obj, binding.YAML).

func (*Context)Status

func (c *Context) Status(codeint)

Status sets the HTTP response code.

func (*Context)Stream

func (c *Context) Stream(step func(wio.Writer)bool)bool

Stream sends a streaming response and returns a booleanindicates "Is client disconnected in middle of stream"

func (*Context)String

func (c *Context) String(codeint, formatstring, values ...any)

String writes the given string into the response body.

func (*Context)TOMLadded inv1.8.0

func (c *Context) TOML(codeint, objany)

TOML serializes the given struct as TOML into the response body.

func (*Context)Value

func (c *Context) Value(keyany)any

Value returns the value associated with this context for key, or nilif no value is associated with key. Successive calls to Value withthe same key returns the same result.

func (*Context)XML

func (c *Context) XML(codeint, objany)

XML serializes the given struct as XML into the response body.It also sets the Content-Type as "application/xml".

func (*Context)YAML

func (c *Context) YAML(codeint, objany)

YAML serializes the given struct as YAML into the response body.

typeContextKeyTypeadded inv1.10.0

type ContextKeyTypeint
const ContextRequestKeyContextKeyType = 0

typeEngine

type Engine struct {RouterGroup// RedirectTrailingSlash enables automatic redirection if the current route can't be matched but a// handler for the path with (without) the trailing slash exists.// For example if /foo/ is requested but a route only exists for /foo, the// client is redirected to /foo with http status code 301 for GET requests// and 307 for all other request methods.RedirectTrailingSlashbool// RedirectFixedPath if enabled, the router tries to fix the current request path, if no// handle is registered for it.// First superfluous path elements like ../ or // are removed.// Afterwards the router does a case-insensitive lookup of the cleaned path.// If a handle can be found for this route, the router makes a redirection// to the corrected path with status code 301 for GET requests and 307 for// all other request methods.// For example /FOO and /..//Foo could be redirected to /foo.// RedirectTrailingSlash is independent of this option.RedirectFixedPathbool// HandleMethodNotAllowed if enabled, the router checks if another method is allowed for the// current route, if the current request can not be routed.// If this is the case, the request is answered with 'Method Not Allowed'// and HTTP status code 405.// If no other Method is allowed, the request is delegated to the NotFound// handler.HandleMethodNotAllowedbool// ForwardedByClientIP if enabled, client IP will be parsed from the request's headers that// match those stored at `(*gin.Engine).RemoteIPHeaders`. If no IP was// fetched, it falls back to the IP obtained from// `(*gin.Context).Request.RemoteAddr`.ForwardedByClientIPbool// AppEngine was deprecated.// Deprecated: USE `TrustedPlatform` WITH VALUE `gin.PlatformGoogleAppEngine` INSTEAD// #726 #755 If enabled, it will trust some headers starting with// 'X-AppEngine...' for better integration with that PaaS.AppEnginebool// UseRawPath if enabled, the url.RawPath will be used to find parameters.UseRawPathbool// UnescapePathValues if true, the path value will be unescaped.// If UseRawPath is false (by default), the UnescapePathValues effectively is true,// as url.Path gonna be used, which is already unescaped.UnescapePathValuesbool// RemoveExtraSlash a parameter can be parsed from the URL even with extra slashes.// See the PR #1817 and issue #1644RemoveExtraSlashbool// RemoteIPHeaders list of headers used to obtain the client IP when// `(*gin.Engine).ForwardedByClientIP` is `true` and// `(*gin.Context).Request.RemoteAddr` is matched by at least one of the// network origins of list defined by `(*gin.Engine).SetTrustedProxies()`.RemoteIPHeaders []string// TrustedPlatform if set to a constant of value gin.Platform*, trusts the headers set by// that platform, for example to determine the client IPTrustedPlatformstring// MaxMultipartMemory value of 'maxMemory' param that is given to http.Request's ParseMultipartForm// method call.MaxMultipartMemoryint64// UseH2C enable h2c support.UseH2Cbool// ContextWithFallback enable fallback Context.Deadline(), Context.Done(), Context.Err() and Context.Value() when Context.Request.Context() is not nil.ContextWithFallbackboolHTMLRenderrender.HTMLRenderFuncMaptemplate.FuncMap// contains filtered or unexported fields}

Engine is the framework's instance, it contains the muxer, middleware and configuration settings.Create an instance of Engine, by using New() or Default()

funcDefault

func Default(opts ...OptionFunc) *Engine

Default returns an Engine instance with the Logger and Recovery middleware already attached.

funcNew

func New(opts ...OptionFunc) *Engine

New returns a new blank Engine instance without any middleware attached.By default, the configuration is:- RedirectTrailingSlash: true- RedirectFixedPath: false- HandleMethodNotAllowed: false- ForwardedByClientIP: true- UseRawPath: false- UnescapePathValues: true

func (*Engine)Delimsadded inv1.3.0

func (engine *Engine) Delims(left, rightstring) *Engine

Delims sets template left and right delims and returns an Engine instance.

func (*Engine)HandleContextadded inv1.3.0

func (engine *Engine) HandleContext(c *Context)

HandleContext re-enters a context that has been rewritten.This can be done by setting c.Request.URL.Path to your new target.Disclaimer: You can loop yourself to deal with this, use wisely.

func (*Engine)Handleradded inv1.8.0

func (engine *Engine) Handler()http.Handler

func (*Engine)LoadHTMLFSadded inv1.11.0

func (engine *Engine) LoadHTMLFS(fshttp.FileSystem, patterns ...string)

LoadHTMLFS loads an http.FileSystem and a slice of patternsand associates the result with HTML renderer.

func (*Engine)LoadHTMLFiles

func (engine *Engine) LoadHTMLFiles(files ...string)

LoadHTMLFiles loads a slice of HTML filesand associates the result with HTML renderer.

func (*Engine)LoadHTMLGlob

func (engine *Engine) LoadHTMLGlob(patternstring)

LoadHTMLGlob loads HTML files identified by glob patternand associates the result with HTML renderer.

func (*Engine)NoMethod

func (engine *Engine) NoMethod(handlers ...HandlerFunc)

NoMethod sets the handlers called when Engine.HandleMethodNotAllowed = true.

func (*Engine)NoRoute

func (engine *Engine) NoRoute(handlers ...HandlerFunc)

NoRoute adds handlers for NoRoute. It returns a 404 code by default.

func (*Engine)Routes

func (engine *Engine) Routes() (routesRoutesInfo)

Routes returns a slice of registered routes, including some useful information, such as:the http method, path, and the handler name.

func (*Engine)Run

func (engine *Engine) Run(addr ...string) (errerror)

Run attaches the router to a http.Server and starts listening and serving HTTP requests.It is a shortcut for http.ListenAndServe(addr, router)Note: this method will block the calling goroutine indefinitely unless an error happens.

func (*Engine)RunFdadded inv1.4.0

func (engine *Engine) RunFd(fdint) (errerror)

RunFd attaches the router to a http.Server and starts listening and serving HTTP requeststhrough the specified file descriptor.Note: this method will block the calling goroutine indefinitely unless an error happens.

func (*Engine)RunListeneradded inv1.5.0

func (engine *Engine) RunListener(listenernet.Listener) (errerror)

RunListener attaches the router to a http.Server and starts listening and serving HTTP requeststhrough the specified net.Listener

func (*Engine)RunQUICadded inv1.11.0

func (engine *Engine) RunQUIC(addr, certFile, keyFilestring) (errerror)

RunQUIC attaches the router to a http.Server and starts listening and serving QUIC requests.It is a shortcut for http3.ListenAndServeQUIC(addr, certFile, keyFile, router)Note: this method will block the calling goroutine indefinitely unless an error happens.

func (*Engine)RunTLS

func (engine *Engine) RunTLS(addr, certFile, keyFilestring) (errerror)

RunTLS attaches the router to a http.Server and starts listening and serving HTTPS (secure) requests.It is a shortcut for http.ListenAndServeTLS(addr, certFile, keyFile, router)Note: this method will block the calling goroutine indefinitely unless an error happens.

func (*Engine)RunUnix

func (engine *Engine) RunUnix(filestring) (errerror)

RunUnix attaches the router to a http.Server and starts listening and serving HTTP requeststhrough the specified unix socket (i.e. a file).Note: this method will block the calling goroutine indefinitely unless an error happens.

func (*Engine)SecureJsonPrefixadded inv1.3.0

func (engine *Engine) SecureJsonPrefix(prefixstring) *Engine

SecureJsonPrefix sets the secureJSONPrefix used in Context.SecureJSON.

func (*Engine)ServeHTTP

func (engine *Engine) ServeHTTP(whttp.ResponseWriter, req *http.Request)

ServeHTTP conforms to the http.Handler interface.

func (*Engine)SetFuncMapadded inv1.3.0

func (engine *Engine) SetFuncMap(funcMaptemplate.FuncMap)

SetFuncMap sets the FuncMap used for template.FuncMap.

func (*Engine)SetHTMLTemplate

func (engine *Engine) SetHTMLTemplate(templ *template.Template)

SetHTMLTemplate associate a template with HTML renderer.

func (*Engine)SetTrustedProxiesadded inv1.7.5

func (engine *Engine) SetTrustedProxies(trustedProxies []string)error

SetTrustedProxies set a list of network origins (IPv4 addresses,IPv4 CIDRs, IPv6 addresses or IPv6 CIDRs) from which to trustrequest's headers that contain alternative client IP when`(*gin.Engine).ForwardedByClientIP` is `true`. `TrustedProxies`feature is enabled by default, and it also trusts all proxiesby default. If you want to disable this feature, useEngine.SetTrustedProxies(nil), then Context.ClientIP() willreturn the remote address directly.

func (*Engine)Use

func (engine *Engine) Use(middleware ...HandlerFunc)IRoutes

Use attaches a global middleware to the router. i.e. the middleware attached through Use() will beincluded in the handlers chain for every single request. Even 404, 405, static files...For example, this is the right place for a logger or error management middleware.

func (*Engine)Withadded inv1.10.0

func (engine *Engine) With(opts ...OptionFunc) *Engine

With returns an Engine with the configuration set in the OptionFunc.

typeError

type Error struct {ErrerrorTypeErrorTypeMetaany}

Error represents a error's specification.

func (Error)Error

func (msgError) Error()string

Error implements the error interface.

func (*Error)IsType

func (msg *Error) IsType(flagsErrorType)bool

IsType judges one error.

func (*Error)JSON

func (msg *Error) JSON()any

JSON creates a properly formatted JSON

func (*Error)MarshalJSON

func (msg *Error) MarshalJSON() ([]byte,error)

MarshalJSON implements the json.Marshaller interface.

func (*Error)SetMeta

func (msg *Error) SetMeta(dataany) *Error

SetMeta sets the error's meta data.

func (*Error)SetType

func (msg *Error) SetType(flagsErrorType) *Error

SetType sets the error's type.

func (Error)Unwrapadded inv1.7.0

func (msgError) Unwrap()error

Unwrap returns the wrapped error, to allow interoperability with errors.Is(), errors.As() and errors.Unwrap()

typeErrorType

type ErrorTypeuint64

ErrorType is an unsigned 64-bit error code as defined in the gin spec.

const (// ErrorTypeBind is used when Context.Bind() fails.ErrorTypeBindErrorType = 1 << 63// ErrorTypeRender is used when Context.Render() fails.ErrorTypeRenderErrorType = 1 << 62// ErrorTypePrivate indicates a private error.ErrorTypePrivateErrorType = 1 << 0// ErrorTypePublic indicates a public error.ErrorTypePublicErrorType = 1 << 1// ErrorTypeAny indicates any other error.ErrorTypeAnyErrorType = 1<<64 - 1// ErrorTypeNu indicates any other error.ErrorTypeNu = 2)

typeH

type H map[string]any

H is a shortcut for map[string]any

func (H)MarshalXML

func (hH) MarshalXML(e *xml.Encoder, startxml.StartElement)error

MarshalXML allows type H to be used with xml.Marshal.

typeHandlerFunc

type HandlerFunc func(*Context)

HandlerFunc defines the handler used by gin middleware as return value.

funcBasicAuth

func BasicAuth(accountsAccounts)HandlerFunc

BasicAuth returns a Basic HTTP Authorization middleware. It takes as argument a map[string]string wherethe key is the user name and the value is the password.

funcBasicAuthForProxyadded inv1.10.0

func BasicAuthForProxy(accountsAccounts, realmstring)HandlerFunc

BasicAuthForProxy returns a Basic HTTP Proxy-Authorization middleware.If the realm is empty, "Proxy Authorization Required" will be used by default.

funcBasicAuthForRealm

func BasicAuthForRealm(accountsAccounts, realmstring)HandlerFunc

BasicAuthForRealm returns a Basic HTTP Authorization middleware. It takes as arguments a map[string]string wherethe key is the user name and the value is the password, as well as the name of the Realm.If the realm is empty, "Authorization Required" will be used by default.(seehttp://tools.ietf.org/html/rfc2617#section-1.2)

funcBind

func Bind(valany)HandlerFunc

Bind is a helper function for given interface object and returns a Gin middleware.

funcCustomRecoveryadded inv1.7.0

func CustomRecovery(handleRecoveryFunc)HandlerFunc

CustomRecovery returns a middleware that recovers from any panics and calls the provided handle func to handle it.

funcCustomRecoveryWithWriteradded inv1.7.0

func CustomRecoveryWithWriter(outio.Writer, handleRecoveryFunc)HandlerFunc

CustomRecoveryWithWriter returns a middleware for a given writer that recovers from any panics and calls the provided handle func to handle it.

funcErrorLogger

func ErrorLogger()HandlerFunc

ErrorLogger returns a HandlerFunc for any error type.

funcErrorLoggerT

func ErrorLoggerT(typErrorType)HandlerFunc

ErrorLoggerT returns a HandlerFunc for a given error type.

funcLogger

func Logger()HandlerFunc

Logger instances a Logger middleware that will write the logs to gin.DefaultWriter.By default, gin.DefaultWriter = os.Stdout.

funcLoggerWithConfigadded inv1.4.0

func LoggerWithConfig(confLoggerConfig)HandlerFunc

LoggerWithConfig instance a Logger middleware with config.

funcLoggerWithFormatteradded inv1.4.0

func LoggerWithFormatter(fLogFormatter)HandlerFunc

LoggerWithFormatter instance a Logger middleware with the specified log format function.

funcLoggerWithWriter

func LoggerWithWriter(outio.Writer, notlogged ...string)HandlerFunc

LoggerWithWriter instance a Logger middleware with the specified writer buffer.Example: os.Stdout, a file opened in write mode, a socket...

funcRecovery

func Recovery()HandlerFunc

Recovery returns a middleware that recovers from any panics and writes a 500 if there was one.

funcRecoveryWithWriter

func RecoveryWithWriter(outio.Writer, recovery ...RecoveryFunc)HandlerFunc

RecoveryWithWriter returns a middleware for a given writer that recovers from any panics and writes a 500 if there was one.

funcWrapF

WrapF is a helper function for wrapping http.HandlerFunc and returns a Gin middleware.

funcWrapH

WrapH is a helper function for wrapping http.Handler and returns a Gin middleware.

typeHandlersChain

type HandlersChain []HandlerFunc

HandlersChain defines a HandlerFunc slice.

func (HandlersChain)Last

Last returns the last handler in the chain. i.e. the last handler is the main one.

typeIRouter

type IRouter interface {IRoutesGroup(string, ...HandlerFunc) *RouterGroup}

IRouter defines all router handle interface includes single and group router.

typeIRoutes

IRoutes defines all router handle interface.

typeLogFormatteradded inv1.4.0

type LogFormatter func(paramsLogFormatterParams)string

LogFormatter gives the signature of the formatter function passed to LoggerWithFormatter

typeLogFormatterParamsadded inv1.4.0

type LogFormatterParams struct {Request *http.Request// TimeStamp shows the time after the server returns a response.TimeStamptime.Time// StatusCode is HTTP response code.StatusCodeint// Latency is how much time the server cost to process a certain request.Latencytime.Duration// ClientIP equals Context's ClientIP method.ClientIPstring// Method is the HTTP method given to the request.Methodstring// Path is a path the client requests.Pathstring// ErrorMessage is set if error has occurred in processing the request.ErrorMessagestring// BodySize is the size of the Response BodyBodySizeint// Keys are the keys set on the request's context.Keys map[any]any// contains filtered or unexported fields}

LogFormatterParams is the structure any formatter will be handed when time to log comes

func (*LogFormatterParams)IsOutputColoradded inv1.4.0

func (p *LogFormatterParams) IsOutputColor()bool

IsOutputColor indicates whether can colors be outputted to the log.

func (*LogFormatterParams)MethodColoradded inv1.4.0

func (p *LogFormatterParams) MethodColor()string

MethodColor is the ANSI color for appropriately logging http method to a terminal.

func (*LogFormatterParams)ResetColoradded inv1.4.0

func (p *LogFormatterParams) ResetColor()string

ResetColor resets all escape attributes.

func (*LogFormatterParams)StatusCodeColoradded inv1.4.0

func (p *LogFormatterParams) StatusCodeColor()string

StatusCodeColor is the ANSI color for appropriately logging http status code to a terminal.

typeLoggerConfigadded inv1.4.0

type LoggerConfig struct {// Optional. Default value is gin.defaultLogFormatterFormatterLogFormatter// Output is a writer where logs are written.// Optional. Default value is gin.DefaultWriter.Outputio.Writer// SkipPaths is a URL path array which logs are not written.// Optional.SkipPaths []string// Skip is a Skipper that indicates which logs should not be written.// Optional.SkipSkipper}

LoggerConfig defines the config for Logger middleware.

typeNegotiate

type Negotiate struct {Offered  []stringHTMLNamestringHTMLDataanyJSONDataanyXMLDataanyYAMLDataanyDataanyTOMLDataany}

Negotiate contains all negotiations data.

typeOnlyFilesFSadded inv1.11.0

type OnlyFilesFS struct {FileSystemhttp.FileSystem}

OnlyFilesFS implements an http.FileSystem without `Readdir` functionality.

func (OnlyFilesFS)Openadded inv1.11.0

func (oOnlyFilesFS) Open(namestring) (http.File,error)

Open passes `Open` to the upstream implementation without `Readdir` functionality.

typeOptionFuncadded inv1.10.0

type OptionFunc func(*Engine)

OptionFunc defines the function to change the default configuration

typeParam

type Param struct {KeystringValuestring}

Param is a single URL parameter, consisting of a key and a value.

typeParams

type Params []Param

Params is a Param-slice, as returned by the router.The slice is ordered, the first URL parameter is also the first slice value.It is therefore safe to read values by the index.

func (Params)ByName

func (psParams) ByName(namestring) (vastring)

ByName returns the value of the first Param which key matches the given name.If no matching Param is found, an empty string is returned.

func (Params)Get

func (psParams) Get(namestring) (string,bool)

Get returns the value of the first Param which key matches the given name and a boolean true.If no matching Param is found, an empty string is returned and a boolean false .

typeRecoveryFuncadded inv1.7.0

type RecoveryFunc func(c *Context, errany)

RecoveryFunc defines the function passable to CustomRecovery.

typeResponseWriter

type ResponseWriter interface {http.ResponseWriterhttp.Hijackerhttp.Flusherhttp.CloseNotifier// Status returns the HTTP response status code of the current request.Status()int// Size returns the number of bytes already written into the response http body.// See Written()Size()int// WriteString writes the string into the response body.WriteString(string) (int,error)// Written returns true if the response body was already written.Written()bool// WriteHeaderNow forces to write the http header (status code + headers).WriteHeaderNow()// Pusher get the http.Pusher for server pushPusher()http.Pusher}

ResponseWriter ...

typeRouteInfo

type RouteInfo struct {MethodstringPathstringHandlerstringHandlerFuncHandlerFunc}

RouteInfo represents a request route's specification which contains method and path and its handler.

typeRouterGroup

type RouterGroup struct {HandlersHandlersChain// contains filtered or unexported fields}

RouterGroup is used internally to configure router, a RouterGroup is associated witha prefix and an array of handlers (middleware).

func (*RouterGroup)Any

func (group *RouterGroup) Any(relativePathstring, handlers ...HandlerFunc)IRoutes

Any registers a route that matches all the HTTP methods.GET, POST, PUT, PATCH, HEAD, OPTIONS, DELETE, CONNECT, TRACE.

func (*RouterGroup)BasePath

func (group *RouterGroup) BasePath()string

BasePath returns the base path of router group.For example, if v := router.Group("/rest/n/v1/api"), v.BasePath() is "/rest/n/v1/api".

func (*RouterGroup)DELETE

func (group *RouterGroup) DELETE(relativePathstring, handlers ...HandlerFunc)IRoutes

DELETE is a shortcut for router.Handle("DELETE", path, handlers).

func (*RouterGroup)GET

func (group *RouterGroup) GET(relativePathstring, handlers ...HandlerFunc)IRoutes

GET is a shortcut for router.Handle("GET", path, handlers).

func (*RouterGroup)Group

func (group *RouterGroup) Group(relativePathstring, handlers ...HandlerFunc) *RouterGroup

Group creates a new router group. You should add all the routes that have common middlewares or the same path prefix.For example, all the routes that use a common middleware for authorization could be grouped.

func (*RouterGroup)HEAD

func (group *RouterGroup) HEAD(relativePathstring, handlers ...HandlerFunc)IRoutes

HEAD is a shortcut for router.Handle("HEAD", path, handlers).

func (*RouterGroup)Handle

func (group *RouterGroup) Handle(httpMethod, relativePathstring, handlers ...HandlerFunc)IRoutes

Handle registers a new request handle and middleware with the given path and method.The last handler should be the real handler, the other ones should be middleware that can and should be shared among different routes.See the example code in GitHub.

For GET, POST, PUT, PATCH and DELETE requests the respective shortcutfunctions can be used.

This function is intended for bulk loading and to allow the usage of lessfrequently used, non-standardized or custom methods (e.g. for internalcommunication with a proxy).

func (*RouterGroup)Matchadded inv1.9.0

func (group *RouterGroup) Match(methods []string, relativePathstring, handlers ...HandlerFunc)IRoutes

Match registers a route that matches the specified methods that you declared.

func (*RouterGroup)OPTIONS

func (group *RouterGroup) OPTIONS(relativePathstring, handlers ...HandlerFunc)IRoutes

OPTIONS is a shortcut for router.Handle("OPTIONS", path, handlers).

func (*RouterGroup)PATCH

func (group *RouterGroup) PATCH(relativePathstring, handlers ...HandlerFunc)IRoutes

PATCH is a shortcut for router.Handle("PATCH", path, handlers).

func (*RouterGroup)POST

func (group *RouterGroup) POST(relativePathstring, handlers ...HandlerFunc)IRoutes

POST is a shortcut for router.Handle("POST", path, handlers).

func (*RouterGroup)PUT

func (group *RouterGroup) PUT(relativePathstring, handlers ...HandlerFunc)IRoutes

PUT is a shortcut for router.Handle("PUT", path, handlers).

func (*RouterGroup)Static

func (group *RouterGroup) Static(relativePath, rootstring)IRoutes

Static serves files from the given file system root.Internally a http.FileServer is used, therefore http.NotFound is used insteadof the Router's NotFound handler.To use the operating system's file system implementation,use :

router.Static("/static", "/var/www")

func (*RouterGroup)StaticFS

func (group *RouterGroup) StaticFS(relativePathstring, fshttp.FileSystem)IRoutes

StaticFS works just like `Static()` but a custom `http.FileSystem` can be used instead.Gin by default uses: gin.Dir()

func (*RouterGroup)StaticFile

func (group *RouterGroup) StaticFile(relativePath, filepathstring)IRoutes

StaticFile registers a single route in order to serve a single file of the local filesystem.router.StaticFile("favicon.ico", "./resources/favicon.ico")

func (*RouterGroup)StaticFileFSadded inv1.8.0

func (group *RouterGroup) StaticFileFS(relativePath, filepathstring, fshttp.FileSystem)IRoutes

StaticFileFS works just like `StaticFile` but a custom `http.FileSystem` can be used instead..router.StaticFileFS("favicon.ico", "./resources/favicon.ico", Dir{".", false})Gin by default uses: gin.Dir()

func (*RouterGroup)Use

func (group *RouterGroup) Use(middleware ...HandlerFunc)IRoutes

Use adds middleware to the group, see example code in GitHub.

typeRoutesInfo

type RoutesInfo []RouteInfo

RoutesInfo defines a RouteInfo slice.

typeSkipperadded inv1.10.0

type Skipper func(c *Context)bool

Skipper is a function to skip logs based on provided Context

Source Files

View all Source files

Directories

PathSynopsis
codec
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.
[8]ページ先頭
©2009-2025 Movatter.jp