gin_api

README

gin_api

r := gin.Default()
sdk := gin_api.NewGinApiSdk(r)

sdk.Register(
    &gin_api.ApiData{
        Method: http.MethodGet,
        RelativePath: "health",
    },
    func(ctx *gin.Context){
        return gin.H{
            "status": "OK",
        }
    },
)

Documentation

Index

• type Api
• type ApiData
  • func (a *ApiData) GetDescription() string
  • func (api *ApiData) GetFullUriPath() string
  • func (a *ApiData) GetGroupPath() string
  • func (api *ApiData) GetKeyName() 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)
• type ApiSdk
• type GinApiSdk
  • 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
  • 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
• type RegisterFunc
• type SdkGroup

Types

type Api

type Api interface {
	GetFullUriPath() string
	GetTags() []string
	GetSummary() string
	GetDescription() string
	GetKeyName() string
	GetQuery() any
	GetPayload() any
	GetResponse() any
	GetMethod() string
	GetGroupPath() string
	GetRelativePath() string

	SetGroupPath(path string)
}

type ApiData

type ApiData struct {
	Method       string
	RelativePath string
	Payload      interface{}
	Response     interface{}
	Query        interface{}
	GroupPath    string
	Deprecated   bool
	Tags         []string
	Summary      string
	Description  string
}

func (*ApiData) GetDescription

func (a *ApiData) GetDescription() string

GetDescription implements pdc_swagger.Api.

func (*ApiData) GetFullUriPath

func (api *ApiData) GetFullUriPath() string

func (*ApiData) GetGroupPath

func (a *ApiData) GetGroupPath() string

GetGroupPath implements pdc_swagger.Api.

func (*ApiData) GetKeyName

func (api *ApiData) GetKeyName() string

func (*ApiData) GetMethod

func (a *ApiData) GetMethod() string

GetMethod implements pdc_swagger.Api.

func (*ApiData) GetPayload

func (a *ApiData) GetPayload() any

GetPayload implements pdc_swagger.Api.

func (*ApiData) GetQuery

func (a *ApiData) GetQuery() any

GetQuery implements pdc_swagger.Api.

func (*ApiData) GetRelativePath

func (a *ApiData) GetRelativePath() string

GetRelativePath implements pdc_swagger.Api.

func (*ApiData) GetResponse

func (a *ApiData) GetResponse() any

GetResponse implements pdc_swagger.Api.

func (*ApiData) GetSummary

func (a *ApiData) GetSummary() string

GetSummary implements pdc_swagger.Api.

func (*ApiData) GetTags

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

GetTags implements pdc_swagger.Api.

func (*ApiData) SetGroupPath

func (a *ApiData) SetGroupPath(path string)

SetGroupPath implements pdc_swagger.Api.

type ApiSdk

type ApiSdk interface {
	GetGinEngine() *gin.Engine
	Group(relativePath string) *GinSdkGroup
	RegisterGroup(relativePath string, groupHandler func(group *gin.RouterGroup, register RegisterFunc))
	Register(api Api, handlers ...gin.HandlerFunc) gin.IRoutes
	Use(handler func(Api)) *GinApiSdk
}

type GinApiSdk

type GinApiSdk struct {
	R *gin.Engine
	// contains filtered or unexported fields
}

func NewGinApiSdk

func NewGinApiSdk(r *gin.Engine) *GinApiSdk

func (*GinApiSdk) GetGinEngine

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

func (*GinApiSdk) Group

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

func (*GinApiSdk) Register

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

func (*GinApiSdk) RegisterGroup

func (sdk *GinApiSdk) RegisterGroup(relativePath string, groupHandler func(group *gin.RouterGroup, register RegisterFunc))

func (*GinApiSdk) Use

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

type GinSdkGroup

type GinSdkGroup struct {
	G        *gin.RouterGroup
	Basepath string
	// contains filtered or unexported fields
}

func (*GinSdkGroup) GetGinEngine

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

func (*GinSdkGroup) Group

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

func (*GinSdkGroup) Register

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

type MiddlewareFunc

type MiddlewareFunc func(api Api)

type RegisterFunc

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

type SdkGroup

type SdkGroup interface {
	GetGinEngine() *gin.Engine
	Group(path string) *GinSdkGroup
	Register(api Api, handlers ...gin.HandlerFunc) gin.IRoutes
}