Help us shape the future of Go! Take the 2026 Go Developer Survey

Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

gin_api

package module

Go to main page

Versions in this module

v1

v1.0.1

May 19, 2025

Changes in this version

+ type Api interface

+ GetDescription func() string

+ GetFullUriPath func() string

+ GetGroupPath func() string

+ GetKeyName func() string

+ GetMethod func() string

+ GetPayload func() any

+ GetQuery func() any

+ GetRelativePath func() string

+ GetResponse func() any

+ GetSummary func() string

+ GetTags func() []string

+ SetGroupPath func(path string)

+ type ApiData struct

+ Deprecated bool

+ Description string

+ GroupPath string

+ Method string

+ Payload interface{}

+ Query interface{}

+ RelativePath string

+ Response interface{}

+ Summary string

+ Tags []string

+ func (a *ApiData) GetDescription() string

+ func (a *ApiData) GetGroupPath() string

+ func (a *ApiData) GetMethod() string

+ func (a *ApiData) GetPayload() any

+ func (a *ApiData) GetQuery() any

+ func (a *ApiData) GetRelativePath() string

+ func (a *ApiData) GetResponse() any

+ func (a *ApiData) GetSummary() string

+ func (a *ApiData) GetTags() []string

+ func (a *ApiData) SetGroupPath(path string)

+ func (api *ApiData) GetFullUriPath() string

+ func (api *ApiData) GetKeyName() string

+ type ApiSdk interface

+ GetGinEngine func() *gin.Engine

+ Group func(relativePath string) *GinSdkGroup

+ Register func(api Api, handlers ...gin.HandlerFunc) gin.IRoutes

+ RegisterGroup func(relativePath string, ...)

+ Use func(handler func(Api)) *GinApiSdk

+ type GinApiSdk struct

+ R *gin.Engine

+ func NewGinApiSdk(r *gin.Engine) *GinApiSdk

+ func (sdk *GinApiSdk) GetGinEngine() *gin.Engine

+ func (sdk *GinApiSdk) Group(relativePath string) *GinSdkGroup

+ func (sdk *GinApiSdk) Register(api Api, handlers ...gin.HandlerFunc) gin.IRoutes

+ func (sdk *GinApiSdk) RegisterGroup(relativePath string, ...)

+ func (sdk *GinApiSdk) Use(handler func(Api)) *GinApiSdk

+ type GinSdkGroup struct

+ Basepath string

+ G *gin.RouterGroup

+ func (grp *GinSdkGroup) GetGinEngine() *gin.Engine

+ func (grp *GinSdkGroup) Group(path string) *GinSdkGroup

+ func (grp *GinSdkGroup) Register(api Api, handlers ...gin.HandlerFunc) gin.IRoutes

+ type MiddlewareFunc func(api Api)

+ type RegisterFunc func(api Api, handlers ...gin.HandlerFunc) gin.IRoutes

+ type SdkGroup interface

+ GetGinEngine func() *gin.Engine

+ Group func(path string) *GinSdkGroup

+ Register func(api Api, handlers ...gin.HandlerFunc) gin.IRoutes