kapi

Feb 23, 2023

Changes in this version

type Context

+ func (c *Context) File(fileName string, fileData []byte)

type KApi

+ func (b *KApi) AddControllers(cList ...interface{}) bool

+ type RecoverFunc func(interface{})

type RouteInfo

+ func NewRouteInfo() *RouteInfo

+ func (ri *RouteInfo) Clean()

+ func (ri *RouteInfo) GetGenInfo() *genInfo

+ func (ri *RouteInfo) GetRouteItems() map[string][]RouteItem

+ func (ri *RouteInfo) WriteOut()

+ type RouteItem struct

+ Description string

+ Key string

+ Method string

+ RouterPath string

+ Summary string

type ServerOption

+ BasePath string

Dec 30, 2022

Changes in this version

+ type Server struct

+ Cors struct{ ... }

+ Debug bool

+ DocDesc string

+ DocName string

+ DocVer string

+ EnablePProf bool

+ NeedDoc bool

+ Port int

+ RedirectToDocWhenAccessRoot bool

+ StaticDirs []string

Jul 21, 2022

Changes in this version

type StaticDir

+ Dir string

Jul 19, 2022

Changes in this version

type MethodComment

+ Methods []string

May 30, 2022

Changes in this version

type KApi

+ func Default() *KApi

May 20, 2022

Changes in this version

+ func GetEmptyConfig() []byte

May 19, 2022

Changes in this version

+ const SECTION_SERVER_NAME

+ var GetResultFunc = _defaultGetResult

+ func AddGenOne(handFunName, routerPath string, methods []string)

+ func NewAPIFunc(c *gin.Context) interface

+ func RegisterFuncGetResult(i FuncGetResult)

+ type ApiFunc func(*gin.Context) interface

type Context

+ func NewCtx(c *gin.Context) *Context

+ func (c *Context) GetVersion() string

+ type DefaultBeforeAfter struct

+ func (d *DefaultBeforeAfter) After(req *InterceptorContext) bool

+ func (d *DefaultBeforeAfter) Before(req *InterceptorContext) bool

+ type FuncGetResult = func(code RESULT_CODE, msg string, count int64, data interface{}) (int, interface{})

+ type InterceptorContext struct

+ C *Context

+ Context context.Context

+ Error error

+ FuncName string

+ Req interface{}

+ Resp interface{}

+ RespCode int

type KApi

+ func (b *KApi) BasePath(router gin.IRoutes) string

+ func (b *KApi) Model(middleware ApiFunc) *KApi

type Option

+ func (o *Option) SetApiBasePath(path string) *Option

+ func (o *Option) SetCors(cors cors.Config) *Option

+ func (o *Option) SetDocDescription(desc string) *Option

+ func (o *Option) SetDocDomain(docDomain string) *Option

+ func (o *Option) SetDocName(docName string) *Option

+ func (o *Option) SetDocVersion(ver string) *Option

+ func (o *Option) SetEnablePProf(enable ...bool) *Option

+ func (o *Option) SetIsDebug(isDebug ...bool) *Option

+ func (o *Option) SetNeedDoc(needDoc ...bool) *Option

+ func (o *Option) SetNeedReDoc(needReDoc ...bool) *Option

+ func (o *Option) SetNeedSwagger(needSwagger ...bool) *Option

+ func (o *Option) SetOpenDocInBrowser(open ...bool) *Option

+ func (o *Option) SetPort(port int) *Option

+ func (o *Option) SetRedirectToDocWhenAccessRoot(redirect ...bool) *Option

+ func (o *Option) SetStaticDirs(dir ...string) *Option

+ type RESULT_CODE int

+ const RESULT_CODE_ERROR

+ const RESULT_CODE_FAIL

+ const RESULT_CODE_NOPERMISSION

+ const RESULT_CODE_NOTFOUND

+ const RESULT_CODE_SUCCESS

+ const RESULT_CODE_UNAUTHED

Feb 15, 2023

Changes in this version

+ var ARCH string

+ var BUILDARCH string

+ var BUILDOS string

+ var BUILDTIME string

+ var GOVERSION string

+ var KAPIEXIT = "kapiexit"

+ var OS string

+ var PACKAGENAME string

+ var VERSION string

+ func Debugf(fmt string, args ...any)

+ func Errorf(fmt string, args ...any)

+ func Failf(fmt string, args ...any)

+ func Fatalf(fmt string, args ...any)

+ func Greenf(fmt string, args ...any)

+ func Infof(fmt string, args ...any)

+ func OKf(fmt string, args ...any)

+ func Redf(fmt string, args ...any)

+ func Warnf(fmt string, args ...any)

+ func Whitef(fmt string, args ...any)

+ func Yellowf(fmt string, args ...any)

+ type AfterBind interface

+ AfterBind func(c *Context)

+ type AfterCall interface

+ AfterCall func(c *Context)

+ type BeforeBind interface

+ BeforeBind func(c *Context)

+ type BeforeCall interface

+ BeforeCall func(c *Context)

+ type Context struct

+ ResultBuilder IResultBuilder

+ func (c *Context) Apply(ctl interface{}) error

+ func (c *Context) DataExit(data interface{})

+ func (c *Context) Exit()

+ func (c *Context) FailAndExit(data ...interface{})

+ func (c *Context) GetFormFloat32(key string, def ...float32) float32

+ func (c *Context) GetFormFloat64(key string, def ...float64) float64

+ func (c *Context) GetFormInt(key string, def ...int) int

+ func (c *Context) GetFormInt64(key string, def ...int64) int64

+ func (c *Context) GetFormString(key string, def ...string) string

+ func (c *Context) GetFormUInt(key string, def ...uint) uint

+ func (c *Context) GetPageSize(def ...int) (int, int)

+ func (c *Context) GetQueryBool(key string) bool

+ func (c *Context) GetQueryInt(key string, def ...int) int

+ func (c *Context) GetQueryInt64(key string, def ...int64) int64

+ func (c *Context) GetQueryString(key string, def ...string) string

+ func (c *Context) GetQueryUInt(key string, def ...uint) uint

+ func (c *Context) GetQueryUInt64(key string, def ...uint64) uint64

+ func (c *Context) ListExit(count int64, list interface{})

+ func (c *Context) Map(i ...interface{}) inject.TypeMapper

+ func (c *Context) MapTo(i interface{}, j interface{}) inject.TypeMapper

+ func (c *Context) MessageAndDataExit(message string, data interface{})

+ func (c *Context) Method() string

+ func (c *Context) NoPerm(msg ...string)

+ func (c *Context) NoPermissionExit(msg ...string)

+ func (c *Context) NotFoundExit(msg ...string)

+ func (c *Context) OfFormFile(form string) (string, int64)

+ func (c *Context) Provide(i interface{}) error

+ func (c *Context) RemoteAddr() string

+ func (c *Context) SaveFile(form string, dst string) error

+ func (c *Context) Success(data ...interface{})

+ func (c *Context) SuccessExit(data ...interface{})

+ func (c *Context) UnAuthed(msg ...string)

+ func (c *Context) WriteJSON(obj interface{})

+ type ContextInvoker func(ctx *Context)

+ func (invoke ContextInvoker) Invoke(params []interface{}) ([]reflect.Value, error)

+ type DefaultResultBuilder struct

+ func (d DefaultResultBuilder) OnData(msg string, count int64, data any) (statusCode int, result any)

+ func (d DefaultResultBuilder) OnError(msg string, err error) (statusCode int, result any)

+ func (d DefaultResultBuilder) OnErrorDetail(msg string, err any) (statusCode int, result any)

+ func (d DefaultResultBuilder) OnFail(msg string, data any) (statusCode int, result any)

+ func (d DefaultResultBuilder) OnNoPermission(msg string) (statusCode int, result any)

+ func (d DefaultResultBuilder) OnNotFound(msg string) (statusCode int, result any)

+ func (d DefaultResultBuilder) OnSuccess(msg string, data any) (statusCode int, result any)

+ func (d DefaultResultBuilder) OnUnAuthed(msg string) (statusCode int, result any)

+ type HeaderAuth interface

+ HeaderAuth func(c *Context)

+ type IResultBuilder interface

+ OnData func(msg string, count int64, data any) (statusCode int, result any)

+ OnError func(msg string, err error) (statusCode int, result any)

+ OnErrorDetail func(msg string, err any) (statusCode int, result any)

+ OnFail func(msg string, data any) (statusCode int, result any)

+ OnNoPermission func(msg string) (statusCode int, result any)

+ OnNotFound func(msg string) (statusCode int, result any)

+ OnSuccess func(msg string, data any) (statusCode int, result any)

+ OnUnAuthed func(msg string) (statusCode int, result any)

+ type Interceptor interface

+ After func(*Context)

+ Before func(*Context)

+ type KApi struct

+ func New(f ...func(*Option)) *KApi

+ func (b *KApi) GetEngine() *gin.Engine

+ func (b *KApi) RegisterResultBuilder(builder IResultBuilder)

+ func (b *KApi) RegisterRouter(cList ...interface{})

+ func (b *KApi) Run()

+ func (b *KApi) Settings() *config.YAML

+ type MethodComment struct

+ Description string

+ IsDeprecated bool

+ Key string

+ Method string

+ ResultType string

+ RouterPath string

+ Summary string

+ TokenHeader string

+ type OnError interface

+ OnError func(c *Context, err error)

+ type OnPanic interface

+ OnPanic func(c *Context, err interface{})

+ type OnUnmarshalError interface

+ OnUnmarshalError func(c *Context, err error)

+ type OnValidationError interface

+ OnValidationError func(c *Context, err error)

+ type Option struct

+ Server ServerOption

+ func (o *Option) Get() *config.YAML

+ func (o *Option) SetGinLoggerFormatter(formatter gin.LogFormatter) *Option

+ func (o *Option) SetIntranetIP(ip string) *Option

+ func (o *Option) SetRecoverFunc(f func(interface{})) *Option

+ type RecoverErrorFunc func(interface{})

+ type ResultBuilderUnimplemented struct

+ func (r ResultBuilderUnimplemented) OnData(msg string, count int64, data any) (statusCode int, result any)

+ func (r ResultBuilderUnimplemented) OnError(msg string, err error) (statusCode int, result any)

+ func (r ResultBuilderUnimplemented) OnErrorDetail(msg string, err any) (statusCode int, result any)

+ func (r ResultBuilderUnimplemented) OnFail(msg string, data any) (statusCode int, result any)

+ func (r ResultBuilderUnimplemented) OnNoPermission(msg string) (statusCode int, result any)

+ func (r ResultBuilderUnimplemented) OnNotFound(msg string) (statusCode int, result any)

+ func (r ResultBuilderUnimplemented) OnSuccess(msg string, data any) (statusCode int, result any)

+ func (r ResultBuilderUnimplemented) OnUnAuthed(msg string) (statusCode int, result any)

+ type RouteInfo struct

+ func (ri *RouteInfo) AddFunc(handlerFuncName, routerPath string, method string)

+ func (ri *RouteInfo) SetApiBody(api swagger.APIBody)

+ type ServerOption struct

+ Cors cors.Config

+ Debug bool

+ DocDesc string

+ DocName string

+ DocVer string

+ NeedDoc bool

+ Port int

+ StaticDirs []StaticDir

+ type StaticDir struct

+ Path string

+ Root string