server

Documentation

Index

• Constants
• func P(mf MethodFunc, action string, hdrs ...interface{})
• func ReDocHandler(appName, swaggerURL string) gin.HandlerFunc
• type MethodFunc
• type Router
  • func NewRouter(apiPrefix string, opts ...RouterOption) *Router
  • func (svr *Router) Any(action string, hdrs ...interface{})
  • func (ai Router) AuthInject(issuer string, injector auth.InjectorFunc)
  • func (ai Router) Default(injector auth.InjectorFunc)
  • func (svr *Router) G(action string, hdrs ...interface{})
  • func (svr *Router) GRequireLogin(action string, hdrs ...interface{})
  • func (svr *Router) GinEngine() *gin.Engine
  • func (svr *Router) HandleDoc(model string)
  • func (ai Router) Inject(ctx *gin.Context)
  • func (svr *Router) ListAllRouters()
  • func (svr *Router) P(action string, hdrs ...interface{})
  • func (svr *Router) PRequireEmployee(action string, hdrs ...interface{})
  • func (svr *Router) PRequireLogin(action string, hdrs ...interface{})
  • func (svr *Router) Run(l net.Listener) error
• type RouterOption
  • func WithDeployMode(deployMode string) RouterOption
  • func WithMiddleware(middleware ...gin.HandlerFunc) RouterOption
  • func WithPrefixes(prefixes []string) RouterOption

Constants

const (
	PrefixAPIV3 = "/v3/"

	PrefixAPIDefault = "/v4/"
)

Functions

func P

func P(mf MethodFunc, action string, hdrs ...interface{})

P .

func ReDocHandler

func ReDocHandler(appName, swaggerURL string) gin.HandlerFunc

ReDocHandler 生成 ReDoc 文档页面的 ReDocHandler appName: 应用名称，如 "demoapp" swaggerURL: Swagger JSON 的 URL，如 "/v1/demoapp.docs/doc.json"

Types

type MethodFunc

type MethodFunc func(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

type Router

type Router struct {
	Prefix string
	// contains filtered or unexported fields
}

Router .

func NewRouter

func NewRouter(apiPrefix string, opts ...RouterOption) *Router

NewRouter .

func (*Router) Any

func (svr *Router) Any(action string, hdrs ...interface{})

Any .

func (Router) AuthInject

func (ai Router) AuthInject(issuer string, injector auth.InjectorFunc)

func (Router) Default

func (ai Router) Default(injector auth.InjectorFunc)

func (*Router) G

func (svr *Router) G(action string, hdrs ...interface{})

G .

func (*Router) GRequireLogin

func (svr *Router) GRequireLogin(action string, hdrs ...interface{})

GRequireLogin .

func (*Router) GinEngine

func (svr *Router) GinEngine() *gin.Engine

GinEngine .

func (*Router) HandleDoc

func (svr *Router) HandleDoc(model string)

func (Router) Inject

func (ai Router) Inject(ctx *gin.Context)

func (*Router) ListAllRouters

func (svr *Router) ListAllRouters()

ListAllRouters 列出所有路由

func (*Router) P

func (svr *Router) P(action string, hdrs ...interface{})

P .

func (*Router) PRequireEmployee

func (svr *Router) PRequireEmployee(action string, hdrs ...interface{})

PRequireEmployee .

func (*Router) PRequireLogin

func (svr *Router) PRequireLogin(action string, hdrs ...interface{})

PRequireLogin .

func (*Router) Run

func (svr *Router) Run(l net.Listener) error

Run .

type RouterOption

type RouterOption func(*Router)

func WithDeployMode

func WithDeployMode(deployMode string) RouterOption

func WithMiddleware

func WithMiddleware(middleware ...gin.HandlerFunc) RouterOption

func WithPrefixes

func WithPrefixes(prefixes []string) RouterOption