Gin API 文档

最新推荐文章于 2024-03-11 14:02:49 发布
最新推荐文章于 2024-03-11 14:02:49 发布
阅读量1.1k 收藏 1
点赞数
文章标签： json 运维 golang

package gin

import "gopkg.in/gin-gonic/gin.v1"

Index

Package Files

auth.go context.go debug.go deprecated.go errors.go fs.go gin.go logger.go mode.go path.go recovery.goresponse_writer.go routergroup.go tree.go utils.go

Constants

const (
    MIMEJSON              = binding.MIMEJSON
    MIMEHTML              = binding.MIMEHTML
    MIMEXML               = binding.MIMEXML
    MIMEXML2              = binding.MIMEXML2
    MIMEPlain             = binding.MIMEPlain
    MIMEPOSTForm = binding.MIMEPOSTForm MIMEMultipartPOSTForm = binding.MIMEMultipartPOSTForm )

Content-Type MIME of the most common data formats

const (
    DebugMode   string = "debug"
    ReleaseMode string = "release"
    TestMode    string = "test"
)
const AuthUserKey = "user"
const BindKey = "_gin-gonic/gin/bindkey"
const ENV_GIN_MODE = "GIN_MODE"
const Version = "v1.0rc2"

Version is Framework's version

Variables

var DefaultErrorWriter io.Writer = os.Stderr
var DefaultWriter io.Writer = os.Stdout

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

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

func Dir

func Dir(root string, listDirectory bool) http.FileSystem

Dir returns a http.Filesystem that can be used by http.FileServer(). It is used interally 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.

func DisableBindValidation

func DisableBindValidation()

func IsDebugging

func IsDebugging() bool

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

func Mode

func Mode() string

func SetMode

func SetMode(value string)

type Accounts

type Accounts map[string]string

type Context

type Context struct {
    Request *http.Request
    Writer  ResponseWriter

    Params Params

    Keys     map[string]interface{}
    Errors   errorMsgs
    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.

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 handlers for this request are not called.

func (*Context) AbortWithError
func (c *Context) AbortWithError(code int, err error) *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(code int)

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

func (*Context) Bind
func (c *Context) Bind(obj interface{}) error

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

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

otherwise --> returns an error 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 ParseBody() but this method also writes a 400 error if the json is not valid.

func (*Context) BindJSON
func (c *Context) BindJSON(obj interface{}) error

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

func (*Context) BindWith
func (c *Context) BindWith(obj interface{}, b binding.Binding) error

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

func (*Context) ClientIP
func (c *Context) ClientIP() string

ClientIP implements a best effort algorithm to return the real client IP, it parses X-Real-IP and X-Forwarded-For in order to work properly with reverse-proxies such us: nginx or haproxy.

func (*Context) ContentType
func (c *Context) ContentType() string

ContentType returns the Content-Type header of the request.

func (*Context) Cookie
func (c *Context) Cookie(name string) (string, error)
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 have to be used then the context has to be passed to a goroutine.

func (*Context) Data
func (c *Context) Data(code int, contentType string, data []byte)

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

func (*Context) Deadline
func (c *Context) Deadline() (deadline time.Time, ok bool)
func (*Context) DefaultPostForm
func (c *Context) DefaultPostForm(key, defaultValue string) string

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

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

DefaultQuery returns the keyed url query value if it exists, othewise 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{}
func (*Context) Err
func (c *Context) Err() error
func (*Context) Error
func (c *Context) Error(err 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.

func (*Context) File
func (c *Context) File(filepath string)

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

func (*Context) Get
func (c *Context) Get(key string) (value interface{}, exists bool)

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

func (*Context) GetCookie
func (c *Context) GetCookie(name string) (string, error)
func (*Context) GetPostForm
func (c *Context) GetPostForm(key string) (string, bool)

GetPostForm is like PostForm(key). It returns the specified key from a POST urlencoded form 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(key string) ([]string, bool)

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

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

GetQuery is like Query(), it returns the keyed url query value if it exists `(value, true)` (even when the value is an empty string), othewise 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(key string) ([]string, bool)

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

func (*Context) HTML
func (c *Context) HTML(code int, name string, obj interface{})

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

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) Header
func (c *Context) Header(key, value string)

Header is a 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(code int, obj interface{})

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 to use this only for development propuses since printing pretty JSON is more 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) JSON
func (c *Context) JSON(code int, obj interface{})

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

func (*Context) MustGet
func (c *Context) MustGet(key string) interface{}

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

func (*Context) Negotiate
func (c *Context) Negotiate(code int, config Negotiate)
func (*Context) NegotiateFormat
func (c *Context) NegotiateFormat(offered ...string) string
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(key string) 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"
})
func (*Context) PostForm
func (c *Context) PostForm(key string) string

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

func (*Context) PostFormArray
func (c *Context) PostFormArray(key string) []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) Query
func (c *Context) Query(key string) string

Query returns the keyed url query value if it exists, othewise 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(key string) []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) Redirect
func (c *Context) Redirect(code int, location string)

Redirect returns a HTTP redirect to the specific location.

func (*Context) Render
func (c *Context) Render(code int, r render.Render)
func (*Context) SSEvent
func (c *Context) SSEvent(name string, message interface{})

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

func (*Context) Set
func (c *Context) Set(key string, value interface{})

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

func (*Context) SetAccepted
func (c *Context) SetAccepted(formats ...string)
func (*Context) SetCookie
func (c *Context) SetCookie(
    name string,
    value string,
    maxAge int,
    path string,
    domain string,
    secure bool,
    httpOnly bool,
)
func (*Context) Status
func (c *Context) Status(code int)
func (*Context) Stream
func (c *Context) Stream(step func(w io.Writer) bool)
func (*Context) String
func (c *Context) String(code int, format string, values ...interface{})

String writes the given string into the response body.

func (*Context) Value
func (c *Context) Value(key interface{}) interface{}
func (*Context) XML
func (c *Context) XML(code int, obj interface{})

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(code int, obj interface{})

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

type Engine

type Engine struct {
    RouterGroup
    HTMLRender render.HTMLRender

    // 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.
    RedirectTrailingSlash bool

    // 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.
    RedirectFixedPath bool

    // 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. HandleMethodNotAllowed bool ForwardedByClientIP bool // 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()

func Default
func Default() *Engine

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

func New
func New() *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

func (*Engine) LoadHTMLFiles
func (engine *Engine) LoadHTMLFiles(files ...string)
func (*Engine) LoadHTMLGlob
func (engine *Engine) LoadHTMLGlob(pattern string)
func (*Engine) NoMethod
func (engine *Engine) NoMethod(handlers ...HandlerFunc)

NoMethod sets the handlers called when... TODO

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

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

func (*Engine) Routes
func (engine *Engine) Routes() (routes RoutesInfo)

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) (err error)

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) RunTLS
func (engine *Engine) RunTLS(addr string, certFile string, keyFile string) (err error)

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(file string) (err error)

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

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

Conforms to the http.Handler interface.

func (*Engine) SetHTMLTemplate
func (engine *Engine) SetHTMLTemplate(templ *template.Template)
func (*Engine) Use
func (engine *Engine) Use(middleware ...HandlerFunc) IRoutes

Use attachs a global middleware to the router. ie. the middleware attached though Use() will be included 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.

type Error

type Error struct {
    Err  error
    Type ErrorType
    Meta interface{}
}
func (*Error) Error
func (msg *Error) Error() string

Implements the error interface

func (*Error) IsType
func (msg *Error) IsType(flags ErrorType) bool
func (*Error) JSON
func (msg *Error) JSON() interface{}
func (*Error) MarshalJSON
func (msg *Error) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface

func (*Error) SetMeta
func (msg *Error) SetMeta(data interface{}) *Error
func (*Error) SetType
func (msg *Error) SetType(flags ErrorType) *Error

type ErrorType

type ErrorType uint64
const (
    ErrorTypeBind    ErrorType = 1 << 63 // used when c.Bind() fails
    ErrorTypeRender  ErrorType = 1 << 62 // used when c.Render() fails
    ErrorTypePrivate ErrorType = 1 << 0
    ErrorTypePublic ErrorType = 1 << 1 ErrorTypeAny ErrorType = 1<<64 - 1 ErrorTypeNu = 2 )

type H

type H map[string]interface{}
func (H) MarshalXML
func (h H) MarshalXML(e *xml.Encoder, start xml.StartElement) error

MarshalXML allows type H to be used with xml.Marshal

type HandlerFunc

type HandlerFunc func(*Context)
func BasicAuth
func BasicAuth(accounts Accounts) HandlerFunc

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

func BasicAuthForRealm
func BasicAuthForRealm(accounts Accounts, realm string) HandlerFunc

BasicAuthForRealm returns a Basic HTTP Authorization middleware. It takes as arguments a map[string]string where the 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. (see http://tools.ietf.org/html/rfc2617#section-1.2)

func Bind
func Bind(val interface{}) HandlerFunc
func ErrorLogger
func ErrorLogger() HandlerFunc
func ErrorLoggerT
func ErrorLoggerT(typ ErrorType) HandlerFunc
func Logger
func Logger() HandlerFunc

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

func LoggerWithWriter
func LoggerWithWriter(out io.Writer, notlogged ...string) HandlerFunc

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

func Recovery
func Recovery() HandlerFunc

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

func RecoveryWithWriter
func RecoveryWithWriter(out io.Writer) HandlerFunc
func WrapF
func WrapF(f http.HandlerFunc) HandlerFunc
func WrapH
func WrapH(h http.Handler) HandlerFunc

type HandlersChain

type HandlersChain []HandlerFunc
func (HandlersChain) Last
func (c HandlersChain) Last() HandlerFunc

Last returns the last handler in the chain. ie. the last handler is the main own.

type IRouter

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

type IRoutes

type IRoutes interface {
    Use(...HandlerFunc) IRoutes

    Handle(string, string, ...HandlerFunc) IRoutes
    Any(string, ...HandlerFunc) IRoutes
    GET(string, ...HandlerFunc) IRoutes
    POST(string, ...HandlerFunc) IRoutes
    DELETE(string, ...HandlerFunc) IRoutes PATCH(string, ...HandlerFunc) IRoutes PUT(string, ...HandlerFunc) IRoutes OPTIONS(string, ...HandlerFunc) IRoutes HEAD(string, ...HandlerFunc) IRoutes StaticFile(string, string) IRoutes Static(string, string) IRoutes StaticFS(string, http.FileSystem) IRoutes }

type Negotiate

type Negotiate struct {
    Offered  []string
    HTMLName string
    HTMLData interface{}
    JSONData interface{}
    XMLData  interface{}
    Data interface{} }

type Param

type Param struct {
    Key   string
    Value string
}

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

type Params

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 (ps Params) ByName(name string) (va string)

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 (ps Params) Get(name string) (string, bool)

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

type ResponseWriter

type ResponseWriter interface {
    http.ResponseWriter
    http.Hijacker
    http.Flusher
    http.CloseNotifier

    // Returns the HTTP response status code of the current request.
    Status() int

    // Returns the number of bytes already written into the response http body.
    // See Written()
    Size() int

    // Writes the string into the response body.
    WriteString(string) (int, error) // Returns true if the response body was already written. Written() bool // Forces to write the http header (status code + headers). WriteHeaderNow() }

type RouteInfo

type RouteInfo struct {
    Method  string
    Path    string
    Handler string
}

type RouterGroup

type RouterGroup struct {
    Handlers HandlersChain
    // contains filtered or unexported fields
}

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

func (*RouterGroup) Any
func (group *RouterGroup) Any(relativePath string, 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
func (*RouterGroup) DELETE
func (group *RouterGroup) DELETE(relativePath string, handlers ...HandlerFunc) IRoutes

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

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

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

func (*RouterGroup) Group
func (group *RouterGroup) Group(relativePath string, handlers ...HandlerFunc) *RouterGroup

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

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

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

func (*RouterGroup) Handle
func (group *RouterGroup) Handle(httpMethod, relativePath string, 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 shortcut functions can be used.

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

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

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

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

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

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

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

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

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

func (*RouterGroup) Static
func (group *RouterGroup) Static(relativePath, root string) IRoutes

Static serves files from the given file system root. Internally a http.FileServer is used, therefore http.NotFound is used instead of 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(relativePath string, fs http.FileSystem) IRoutes

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

func (*RouterGroup) StaticFile
func (group *RouterGroup) StaticFile(relativePath, filepath string) IRoutes

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

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

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

type RoutesInfo

type RoutesInfo []RouteInfo

Directories

PathSynopsis
binding 
binding/examplePackage example is a generated protocol buffer package.
examples/app-engine 
examples/basic 
examples/realtime-advanced 
examples/realtime-chat 
ginS 
render
weixin_34090562
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
gin 生成api文档_Golang使用Gin框架整合Swagger生成api文档
weixin_39595008的博客
01-13 451
一、环境介绍二、开始整合1、安装swagger2、Gin router代码3、api代码4、生成api配置文档5、访问swagger一、环境介绍Go版本：1.13.1开发工具：IntelliJ IDEA 2019.2.3 x64开发环境：windows 10 64位二、开始整合代码目录结构 1、安装swaggerIDEA Terminal 项目根目录执行go get -u github.com/...
11、Go gin 获取请求IP，nginx配置方案
最新发布
qq_39335595的博客
05-11 538
获取用户的真实 IP 地址是许多应用中必不可少的功能，用于识别用户、记录日志、进行安全控制等。在使用 Gin 框架时，我们需要了解如何正确获取用户的 IP，并处理可能涉及的安全问题。
go语言web开发系列之二十七:gin框架:用gin-swagger实现接口文档
刘老师的技术森林
02-03 2992
一，安装用到的库 1，swag库的地址: https://github.com/swaggo/swag 2，安装swag命令: liuhongdi@ku:~$ go get -u github.com/swaggo/swag/cmd/swag 测试安装是否成功? liuhongdi@ku:/data/liuhongdi/digv27$ /home/liuhongdi/go/bin/swag -v swag version v1.6.9 在项目包含main.go文件的目录下执行: liu
gin-swagger生成API文档
一生太短,只够爱一个人
06-25 438
导包 ​ go get -u github.com/swaggo/swag/cmd/swag 在main.go上加入主注释 // @title 希科志愿者项目 // @version 1.0 // @description 希科志愿者项目接口文档 // @host 8083 // @BasePath /api/v1 在接口对应的func上加入api注释 // Create // @Summary 创建召回 // @Tags 召回 // @accept json // @Param Proje..
基于 Gin 模块化开发 API 框架设计
水痕
04-29 2573
一、gin项目介绍 gin框架对于写go语言的人来说入门很简单，有点类似python中的flask框架，什么都需要自己去找第三方包，然后根据自己的经验来创建目录结构，对于没有项目经验的人来说，这点真的不如同类型的beego框架，已经有清晰的目录结构，有时候我们可以说gin仅仅是一个包，算不上框架。自由组装度比较灵活，这也提现了我们开发人员的经验重要性。如何更好的搭建gin-api项目是一个难事。 以下是本人根据后端经验采用mvc的思路搭建一套基本的gin-api框架。以供大家参考使用,大家觉得好点个????
golang工程组件篇:高性能web框架gin之RESTful API与API版本控制
SMILY12138的博客
05-25 501
综上所述，RESTful API和API版本控制是golang工程组件中非常重要的两个组件。通过使用gin框架可以轻松地实现RESTful API，并且通过API版本控制可以有效地管理不同版本的API接口。为了解决这个问题，我们可以使用API版本控制来管理不同版本的API接口。通过向URI中添加版本号或者使用HTTP请求头等方式来标识当前使用的API版本，从而确保客户端能够正确地访问对应版本的接口。三、什么是API版本控制？
gin-swagger:使用 Swagger 2.0 自动生成 RESTful API 文档的 gin 中间件
07-24
gin 中间件使用 Swagger 2.0 自动生成 RESTful API 文档。 用法 开始使用它 向您的 API 源代码添加注释，。 使用以下命令下载 for Go： $ go get -u github.com/swaggo/swag/cmd/swag 在包含main.go文件的 Go 项目...
go 语言框架 gin中文文档
09-11
在本文档中，我们将深入探讨 Gin 的各个方面，包括安装与配置、框架架构、路由、控制器、请求处理、响应生成以及中间件的使用，并结合数据库操作来全面理解 Gin 的强大功能。 ### 1. 安装与配置 在使用 Gin 之前，...
Golang gin中文文档
04-27
在本文档中，我们将深入探讨 Gin 的各种特性。 1. **路由系统** - **基本路由**：Gin 提供了简单的 API 来创建路由。`r.GET("/")`、`r.POST("/xxxpost")`、`r.PUT("/xxxput")` 分别用于注册 GET、POST 和 PUT 方法...
gin文档 中文
06-19
Gin是用Golang实现的一种Web框架。基于 httprouter，它提供了类似martini但更好性能(路由性能约快40倍)的API服务. 如果你希望构建一个高性能的生产环境，你会喜欢上使用 Gin。
go-gin-api：基于Gin进行API设计的框架，封装了常用功能，使用简单，致力于进行快速的业务开发。例如，支持cors跨域，jwt签名验证，收集，紧急异常捕获，trace跟踪，prometheus监控指标，swagger文档生成，viper配置文件解析，gorm数据库组件，graphql查询语言，errno统一定义错误代码，gRPC的使用等等
02-03
关于 go-gin-api是基于进行异步...go-gin-api文档由以下几个主要部分组成： 准备工作 快速开始 目录接口 核心封装 组件指南 工具包 地址： : 其他 查看Jaeger互联网跟踪代码，请查看，文档点这里 。 特别感谢 一起学习
Gin搭建开发API
u014459543的博客
06-21 2455
因为实际开发需要最近在学学Gin框架，感觉Gin框架比之前用的beego框架更简洁，不臃肿；准备把项目的API从laeravel转到Gin； 本次完成的功能：项目搭建，主入口main.go，四个列表接口(列表，总数，分页等)，两种不同的接收参数等； 端口是5050； 执行入口主文件 go run main.go 先上项目的结构图： 主入口文件---------------------------------- package main import ( db “fkHalo/databases” . “f
Gin框架第二天---关于API
shelgi的博客
11-12 756
文章目录Gin第二天1.RESTful API2. API参数问题 Gin第二天 1.RESTful API 简单来说，REST的含义就是客⼾端与Web服务器之间进⾏交互的时候，使⽤HTTP协议中的4个请求⽅法代表不同的动作。它是一种互联网应用程序的API设计理念：URL定位资源，用HTTP描述操作 GET⽤来获取资源 POST⽤来新建资源 PUT⽤来更新资源 DELETE⽤来删除资源。 只要API程序遵循了REST⻛格，那就可以称其为RESTful API。⽬前在前后端分离的架构中，前后端基本都是通
Gin框架日常使用--高频api使用示例
rickiyang的博客
06-16 3804
Go web框架目前有很多，Beego，Gin，Iris，Revel等等。目前国内使用量比较多的是前两个，鉴于Beego的源码一直被人吐槽并且Beego使用起来太过于臃肿，框架本身构造的大而全，很多功能不一定会是你想要的这些原因，我们着重关注Gin框架的使用。Gin没有像Beego那样什么都做，它只专注于web请求的封装，如果你想做缓存，想连接数据库等等还需要使用别的框架或者使用原生的API。 G...
gin常用API
weixin_43923963的博客
11-03 102
注：c 表示 c *gin.Context。核心API：c.File。将服务器图片返回到本地。，重定向到项目具体路由。
ginapi服务器性能,gin框架构建Api之：环境配置和路由
weixin_42151373的博客
08-09 947
Gin是一个golang的微框架，封装比较优雅，API友好，源码注释比较明确，已经发布了1.0版本。具有快速灵活，容错方便等特点。其实对于golang而言，web框架的依赖要远比Python，Java之类的要小。自身的net/http足够简单，性能也非常不错。框架更像是一些常用函数或者工具的集合。借助框架开发，不仅可以省去很多常用的封装带来的时间，也有助于团队的编码风格和形成规范。什么是 APIA...
使用gin框架，编写一个接收数据的api接口
托塔天王的博客
03-11 515
步骤七 运行 这里需要主要 端口和redis 相关配置 可以根据实际情况 修改config.yaml。修改后重新运行即可，无需重新编译。功能：这里主要编写一个接口，将其json 数据存入对应的redis队列中，并统计每天的每小时请求数量。请求地址 http://127.0.0.1:8082/pushData。步骤六 先运行一下 如果不报错 在进行编译。步骤八 请求接口，验证接口处理是否正常。步骤五 项目所需要的依赖添加到。平台 linux X64。若执行不了 请注意。
Gin框架开发go服务API
guo_zhen_qian的专栏
01-26 1035
如何使用gin开发一个go服务程序并部署到linux服务器上
ginapi服务器性能,如何使用 Gin 和 Gorm 搭建一个简单的 API 服务 （一）
weixin_34908663的博客
08-09 419
gin-gonic介绍Go 语言最近十分火热，但对于新手来说，想立马上手全新的语法和各种各样的框架还是有点难度的。即使是基础学习也很有挺有挑战性。在这篇文章中，我想用最少的代码写出一个可用的 API 服务。这个 API 可以提供增删改查(CRUD)这些基本功能，对象关系映射 (ORM) 让数据库操作变得非常简单，不用 100 行代码，都可以搞定。让我们开始吧。起步Gin既然是搭建 API 服务，就...
gin-swagger:使用 swagger 2.0 自动生成 restful api 文档的 gin 中间件
09-02
gin-swagger是一个使用swagger 2.0来自动生成RESTful API文档的gin中间件。 swagger是一个针对RESTful API的规范和工具，它可以通过Swagger注解来定义API的各种元数据，包括API的路径、请求参数、响应数据等信息。...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值