kid

README

kid

Documentation

Index

• type Code
• type Context
  • func (ctx *Context) GetDefaultInt(key string, defaultValue int) int
  • func (ctx *Context) GetDefaultInt64(key string, defaultValue int64) int64
  • func (ctx *Context) GetDefaultString(key, defaultValue string) string
  • func (ctx *Context) GetInt(key string) int
  • func (ctx *Context) GetInt64(key string) int64
  • func (ctx *Context) GetString(key string) string
• type Error
  • func NewError(status *Status, originals ...error) *Error
  • func (e *Error) Error() string
• type HandleFunc
• type Kid
  • func New(opts ...Option) *Kid
  • func (kid *Kid) Launch(hosts ...string)
  • func (kid *Kid) NoMethod(handleFunc HandleFunc)
  • func (kid *Kid) NoRoute(handleFunc HandleFunc)
  • 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 WithConfigs(configs ...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 Status

Types

type Code

type Code int

type Context

type Context struct {
	*gin.Context
	Guard guard.Guard
}

func (*Context) GetDefaultInt

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

func (*Context) GetDefaultInt64

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

func (*Context) GetDefaultString

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

func (*Context) GetInt

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

func (*Context) GetInt64

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

func (*Context) GetString

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

type Error

type Error struct {
	Status   *Status
	Original error
}

func NewError

func NewError(status *Status, originals ...error) *Error

func (*Error) Error

func (e *Error) Error() string

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 (*Kid) Launch

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

func (*Kid) NoMethod

func (kid *Kid) NoMethod(handleFunc HandleFunc)

func (*Kid) NoRoute

func (kid *Kid) NoRoute(handleFunc HandleFunc)

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 WithConfigs

func WithConfigs(configs ...string) Option

type Options

type Options struct {
	Configs []string
}

type RouterGroup

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

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 Status

type Status struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}