gh

Documentation

Overview

Package gh is an abbreviation of gin http.

Index

• func ProvideMiddleware(fn interface{})
• func ProvideRouterGroup(groupName string, fn interface{})
• type App
  • func (app *App) Name() string
  • func (app *App) ParseConfig(ptr interface{}) error
• type Binder
  • func MustBind(fn interface{}) *Binder
  • func (b *Binder) HandlerFunc() gin.HandlerFunc
  • func (b *Binder) SetRespondErr(f ErrHandler) *Binder
  • func (b *Binder) SetRespondOk(f func(c *gin.Context, r interface{})) *Binder
• type ErrHandler

Functions

func ProvideMiddleware

func ProvideMiddleware(fn interface{})

ProvideMiddleware provide middleware

func ProvideRouterGroup

func ProvideRouterGroup(groupName string, fn interface{})

ProvideRouterGroup define a router group and inject it into the runtime, then you can use it anywhere during the project lifecyle.

First, you need to use a function to create a `gin.RouterGroup`:

func init() {
	gh.ProvideRouterGroup("api", func(app *gh.App) *gin.RouterGroup {
		return app.Engine.Group("api")
	})
}

Then, you can use it anywhere with DI:

type routerParams struct {
	fx.In

	Default *gin.RouterGroup `name:"api"`
}

func init() {
	di.Invoke(func(r routerParams) {
		r.Default.GET("/", func(c *gin.Context) {
			c.Writer.WriteString("Hello, world!")
		})
	})
}

Types

type App

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

App Global App

func (*App) Name

func (app *App) Name() string

Name returns app name

func (*App) ParseConfig

func (app *App) ParseConfig(ptr interface{}) error

ParseConfig parse `app` field in config file to an variable

type Binder

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

Binder to customize.

func MustBind

func MustBind(fn interface{}) *Binder

MustBind bind given function into a gin.HandlerFunc, which can decode arguments from request and compose the invocation of the given function.

func (*Binder) HandlerFunc

func (b *Binder) HandlerFunc() gin.HandlerFunc

HandlerFunc returns composed handler function of gin.

func (*Binder) SetRespondErr

func (b *Binder) SetRespondErr(f ErrHandler) *Binder

SetRespondErr define how to respond error

func (*Binder) SetRespondOk

func (b *Binder) SetRespondOk(f func(c *gin.Context, r interface{})) *Binder

SetRespondOk define how to respond ok.

type ErrHandler

type ErrHandler func(c *gin.Context, code int, err error)