kid

README

kid

Documentation

Index

• Constants
• Variables
• func PrintLogo()
• func Struct(value interface{}) error
• func Verify(ctx *Context, rules Rules) (err error)
• type Context
  • func (ctx *Context) FindDefaultFloat32(key string, defaultValue float32) float32
  • func (ctx *Context) FindDefaultFloat64(key string, defaultValue float64) float64
  • func (ctx *Context) FindDefaultInt(key string, defaultValue int) int
  • func (ctx *Context) FindDefaultInt64(key string, defaultValue int64) int64
  • func (ctx *Context) FindDefaultString(key, defaultValue string) string
  • func (ctx *Context) FindFloat32(key string) float32
  • func (ctx *Context) FindFloat64(key string) float64
  • func (ctx *Context) FindInt(key string) int
  • func (ctx *Context) FindInt64(key string) int64
  • func (ctx *Context) FindString(key string) string
  • func (ctx *Context) GetValue(key string, recipient interface{}) error
  • func (ctx *Context) Valid(recipient interface{}) error
  • func (ctx *Context) ValidFiled(rules Rules) error
• type HandleFunc
• type Kid
  • func New(opts ...Option) *Kid
  • func Registry(plugin plugin.Plugin, opts ...container.Option) *Kid
  • func (kid *Kid) AutoMigrate()
  • func (kid *Kid) CommandLine() error
  • func (kid *Kid) Get(plugin plugin.Plugin, name ...string) (interface{}, error)
  • func (kid *Kid) Init() error
  • func (kid *Kid) Launch(hosts ...string)
  • func (kid *Kid) NewDbCommand() *cobra.Command
  • func (kid *Kid) NewHelpCommand() *cobra.Command
  • func (kid *Kid) NewServerCommand() *cobra.Command
  • func (kid *Kid) NoMethod(handleFunc HandleFunc)
  • func (kid *Kid) NoRoute(handleFunc HandleFunc)
  • func (kid *Kid) Populate() error
  • func (kid *Kid) Registry(plugin plugin.Plugin, opts ...container.Option) *Kid
• type LogFormatter
• type LogFormatterParams
• type LoggerConfig
• type Middleware
  • func LoggerWithConfig(conf LoggerConfig) Middleware
  • func LoggerWithFormatter(f LogFormatter) Middleware
• type Option
  • func WithAppName(name string) Option
  • func WithConfigs(configs ...string) Option
  • func WithDbMigrate(migrate mysql.AutoMigrate) Option
  • func WithRunMode(runMode string) Option
• type Options
• type RouterGroup
  • func (group *RouterGroup) DELETE(path string, handler HandleFunc, middlewares ...Middleware)
  • func (group *RouterGroup) GET(path string, handler HandleFunc, middlewares ...Middleware)
  • func (group *RouterGroup) Group(path string, middlewares ...Middleware) *RouterGroup
  • func (group *RouterGroup) POST(path string, handler HandleFunc, middlewares ...Middleware)
  • func (group *RouterGroup) PUT(path string, handler HandleFunc, middlewares ...Middleware)
  • func (group *RouterGroup) UseMiddle(middlewares ...Middleware)
• type Rules

Constants

const CommandLogo = `` /* 401-byte string literal not displayed */

Variables

var Validator = validator.New()

Functions

func PrintLogo

func PrintLogo()

func Struct

func Struct(value interface{}) error

func Verify

func Verify(ctx *Context, rules Rules) (err error)

Types

type Context

type Context struct {
	*gin.Context
	Guard guard.Guard `inject:""`
}

func (*Context) FindDefaultFloat32

func (ctx *Context) FindDefaultFloat32(key string, defaultValue float32) float32

func (*Context) FindDefaultFloat64

func (ctx *Context) FindDefaultFloat64(key string, defaultValue float64) float64

func (*Context) FindDefaultInt

func (ctx *Context) FindDefaultInt(key string, defaultValue int) int

func (*Context) FindDefaultInt64

func (ctx *Context) FindDefaultInt64(key string, defaultValue int64) int64

func (*Context) FindDefaultString

func (ctx *Context) FindDefaultString(key, defaultValue string) string

func (*Context) FindFloat32

func (ctx *Context) FindFloat32(key string) float32

func (*Context) FindFloat64

func (ctx *Context) FindFloat64(key string) float64

func (*Context) FindInt

func (ctx *Context) FindInt(key string) int

func (*Context) FindInt64

func (ctx *Context) FindInt64(key string) int64

func (*Context) FindString

func (ctx *Context) FindString(key string) string

func (*Context) GetValue

func (ctx *Context) GetValue(key string, recipient interface{}) error

func (*Context) Valid

func (ctx *Context) Valid(recipient interface{}) error

func (*Context) ValidFiled

func (ctx *Context) ValidFiled(rules Rules) error

type HandleFunc

type HandleFunc func(*Context) interface{}

type Kid

type Kid struct {
	*gin.Engine
	RouterGroup
	Logger logger.Logger

	Options *Options
	// contains filtered or unexported fields
}

func New

func New(opts ...Option) *Kid

func Registry

func Registry(plugin plugin.Plugin, opts ...container.Option) *Kid

func (*Kid) AutoMigrate

func (kid *Kid) AutoMigrate()

AutoMigrate 自动迁移数据库

func (*Kid) CommandLine

func (kid *Kid) CommandLine() error

CommandLine 命令行处理

func (*Kid) Get

func (kid *Kid) Get(plugin plugin.Plugin, name ...string) (interface{}, error)

func (*Kid) Init

func (kid *Kid) Init() error

func (*Kid) Launch

func (kid *Kid) Launch(hosts ...string)

func (*Kid) NewDbCommand

func (kid *Kid) NewDbCommand() *cobra.Command

NewDbCommand 数据库相关命令

func (*Kid) NewHelpCommand

func (kid *Kid) NewHelpCommand() *cobra.Command

func (*Kid) NewServerCommand

func (kid *Kid) NewServerCommand() *cobra.Command

NewServerCommand 服务启动相关命令

func (*Kid) NoMethod

func (kid *Kid) NoMethod(handleFunc HandleFunc)

func (*Kid) NoRoute

func (kid *Kid) NoRoute(handleFunc HandleFunc)

func (*Kid) Populate

func (kid *Kid) Populate() error

func (*Kid) Registry

func (kid *Kid) Registry(plugin plugin.Plugin, opts ...container.Option) *Kid

Registry 将插件注入容器

type LogFormatter

type LogFormatter func(params LogFormatterParams) string

type LogFormatterParams

type LogFormatterParams struct {
	Request      *http.Request
	TimeStamp    time.Time
	StatusCode   int
	Latency      time.Duration
	ClientIP     string
	Method       string
	Path         string
	ErrorMessage string

	BodySize int
	Keys     map[string]interface{}
	// contains filtered or unexported fields
}

type LoggerConfig

type LoggerConfig struct {
	Formatter LogFormatter
	Output    io.Writer
	SkipPaths []string
}

type Middleware

type Middleware func(*Context)

func LoggerWithConfig

func LoggerWithConfig(conf LoggerConfig) Middleware

func LoggerWithFormatter

func LoggerWithFormatter(f LogFormatter) Middleware

type Option

type Option func(*Options)

func WithAppName

func WithAppName(name string) Option

func WithConfigs

func WithConfigs(configs ...string) Option

func WithDbMigrate

func WithDbMigrate(migrate mysql.AutoMigrate) Option

func WithRunMode

func WithRunMode(runMode string) Option

type Options

type Options struct {
	Name            string
	AutoMigrate     bool
	Configs         []string
	RunMode         string
	DatabaseMigrate mysql.AutoMigrate
}

type RouterGroup

type RouterGroup struct {
	*gin.RouterGroup
}

func (*RouterGroup) DELETE

func (group *RouterGroup) DELETE(path string, handler HandleFunc, middlewares ...Middleware)

func (*RouterGroup) GET

func (group *RouterGroup) GET(path string, handler HandleFunc, middlewares ...Middleware)

func (*RouterGroup) Group

func (group *RouterGroup) Group(path string, middlewares ...Middleware) *RouterGroup

func (*RouterGroup) POST

func (group *RouterGroup) POST(path string, handler HandleFunc, middlewares ...Middleware)

func (*RouterGroup) PUT

func (group *RouterGroup) PUT(path string, handler HandleFunc, middlewares ...Middleware)

func (*RouterGroup) UseMiddle

func (group *RouterGroup) UseMiddle(middlewares ...Middleware)

type Rules

type Rules map[string]interface{}