zdpgo_api

package module

Go to main page

Versions in this module

v1

v1.3.4

Sep 23, 2022

Changes in this version

type Api

+ func (a *Api) AddGroup(relativePath string, handlers ...HandlerFunc) *RouterGroup

+ type Json map[string]interface

+ func (h Json) MarshalXML(e *xml.Encoder, start xml.StartElement) error

v1.3.3

Aug 24, 2022

Changes in this version

type Context

+ func (c *Context) GetResponseFailureWithError(err error) Response

+ func (c *Context) ResponseFailure(msg string)

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

+ func (c *Context) ResponseFailureWithError(err error)

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

v1.3.2

Aug 23, 2022

Changes in this version

+ func Validate(data interface{}) (errData map[string]string)

type Context

+ func (c *Context) GetResponseFailure(err error) Response

+ func (c *Context) GetResponseFailureWithData(data interface{}) Response

v1.3.1

Jul 23, 2022

Changes in this version

+ func GetFreePort() (int, error)

+ func RouterHealthCheck(ctx *Context)

v1.3.0

Jul 17, 2022

Changes in this version

type HandlerFunc

+ func MiddlewareCors() HandlerFunc

v1.2.9

Jul 17, 2022

Changes in this version

+ func RegisterMobileValidator()

+ func ValidateMobile(fl validator.FieldLevel) bool

v1.2.8

Jul 17, 2022

Changes in this version

+ var Trans ut.Translator

+ func GetMd5(data string) string

+ func HandleValidatorError(c *Context, err error)

+ func InitTrans(locale string) (err error)

+ func InitTransChinese() error

type RouterConfig

+ Static bool

+ Upload bool

v1.2.7

Jul 14, 2022

Changes in this version

+ const BindKey

+ const BodyBytesKey

+ const DebugMode

+ const EnvGinMode

+ const MIMEHTML

+ const MIMEJSON

+ const MIMEMultipartPOSTForm

+ const MIMEPOSTForm

+ const MIMEPlain

+ const MIMEXML

+ const MIMEXML2

+ const MIMEYAML

+ const PlatformCloudflare

+ const PlatformGoogleAppEngine

+ const ReleaseMode

+ const TestMode

+ const Version

+ var DefaultErrorWriter io.Writer = os.Stderr

+ var DefaultWriter io.Writer = os.Stdout

+ func CreateDirs(filePath string) error

+ func CreateTestContext(w http.ResponseWriter) (c *Context, r *Engine)

+ func Dir(root string, listDirectory bool) http.FileSystem

+ func DisableBindValidation()

+ func EnableJsonDecoderDisallowUnknownFields()

+ func EnableJsonDecoderUseNumber()

+ func IsDebugging() bool

+ func IsExists(path string) bool

+ func Mode() string

+ func SetMode(value string)

+ type Accounts map[string]string

type Api

+ func NewApi() *Api

type Context

+ Accepted []string

+ Errors errorMsgs

+ Keys map[string]interface{}

+ Params Params

+ Request *http.Request

+ Writer ResponseWriter

+ func (c *Context) Abort()

+ func (c *Context) AbortWithError(code int, err error) *Error

+ func (c *Context) AbortWithStatus(code int)

+ func (c *Context) AbortWithStatusJSON(code int, jsonObj interface{})

+ func (c *Context) AsciiJSON(code int, obj interface{})

+ func (c *Context) Bind(obj interface{}) error

+ func (c *Context) BindHeader(obj interface{}) error

+ func (c *Context) BindJSON(obj interface{}) error

+ func (c *Context) BindQuery(obj interface{}) error

+ func (c *Context) BindUri(obj interface{}) error

+ func (c *Context) BindWith(obj interface{}, b binding.Binding) error

+ func (c *Context) BindXML(obj interface{}) error

+ func (c *Context) ClientIP() string

+ func (c *Context) ContentType() string

+ func (c *Context) Cookie(name string) (string, error)

+ func (c *Context) Copy() *Context

+ func (c *Context) Data(code int, contentType string, data []byte)

+ func (c *Context) DataFromReader(code int, contentLength int64, contentType string, reader io.Reader, ...)

+ func (c *Context) Deadline() (deadline time.Time, ok bool)

+ func (c *Context) DefaultPostForm(key, defaultValue string) string

+ func (c *Context) DefaultQuery(key, defaultValue string) string

+ func (c *Context) Done() <-chan struct{}

+ func (c *Context) Err() error

+ func (c *Context) Error(err error) *Error

+ func (c *Context) File(filepath string)

+ func (c *Context) FileAttachment(filepath, filename string)

+ func (c *Context) FileFromFS(filepath string, fs http.FileSystem)

+ func (c *Context) FormFile(name string) (*multipart.FileHeader, error)

+ func (c *Context) FullPath() string

+ func (c *Context) Get(key string) (value interface{}, exists bool)

+ func (c *Context) GetBool(key string) (b bool)

+ func (c *Context) GetDuration(key string) (d time.Duration)

+ func (c *Context) GetFloat64(key string) (f64 float64)

+ func (c *Context) GetHeader(key string) string

+ func (c *Context) GetInt(key string) (i int)

+ func (c *Context) GetInt64(key string) (i64 int64)

+ func (c *Context) GetPostForm(key string) (string, bool)

+ func (c *Context) GetPostFormArray(key string) ([]string, bool)

+ func (c *Context) GetPostFormMap(key string) (map[string]string, bool)

+ func (c *Context) GetQuery(key string) (string, bool)

+ func (c *Context) GetQueryArray(key string) ([]string, bool)

+ func (c *Context) GetQueryMap(key string) (map[string]string, bool)

+ func (c *Context) GetRawData() ([]byte, error)

+ func (c *Context) GetString(key string) (s string)

+ func (c *Context) GetStringMap(key string) (sm map[string]interface{})

+ func (c *Context) GetStringMapString(key string) (sms map[string]string)

+ func (c *Context) GetStringMapStringSlice(key string) (smss map[string][]string)

+ func (c *Context) GetStringSlice(key string) (ss []string)

+ func (c *Context) GetTime(key string) (t time.Time)

+ func (c *Context) GetUint(key string) (ui uint)

+ func (c *Context) GetUint64(key string) (ui64 uint64)

+ func (c *Context) HTML(code int, name string, obj interface{})

+ func (c *Context) Handler() HandlerFunc

+ func (c *Context) HandlerName() string

+ func (c *Context) HandlerNames() []string

+ func (c *Context) Header(key, value string)

+ func (c *Context) IndentedJSON(code int, obj interface{})

+ func (c *Context) IsAborted() bool

+ func (c *Context) IsWebsocket() bool

+ func (c *Context) JSON(code int, obj interface{})

+ func (c *Context) JSONP(code int, obj interface{})

+ func (c *Context) MultipartForm() (*multipart.Form, error)

+ func (c *Context) MustBindWith(obj interface{}, b binding.Binding) error

+ func (c *Context) MustGet(key string) interface{}

+ func (c *Context) Negotiate(code int, config Negotiate)

+ func (c *Context) NegotiateFormat(offered ...string) string

+ func (c *Context) Next()

+ func (c *Context) Param(key string) string

+ func (c *Context) PostForm(key string) string

+ func (c *Context) PostFormArray(key string) []string

+ func (c *Context) PostFormMap(key string) map[string]string

+ func (c *Context) PureJSON(code int, obj interface{})

+ func (c *Context) Query(key string) string

+ func (c *Context) QueryArray(key string) []string

+ func (c *Context) QueryMap(key string) map[string]string

+ func (c *Context) Redirect(code int, location string)

+ func (c *Context) RemoteIP() (net.IP, bool)

+ func (c *Context) Render(code int, r render.Render)

+ func (c *Context) SSEvent(name string, message interface{})

+ func (c *Context) SaveUploadedFile(file *multipart.FileHeader, dst string) error

+ func (c *Context) SecureJSON(code int, obj interface{})

+ func (c *Context) Set(key string, value interface{})

+ func (c *Context) SetAccepted(formats ...string)

+ func (c *Context) SetCookie(name, value string, maxAge int, path, domain string, secure, httpOnly bool)

+ func (c *Context) SetSameSite(samesite http.SameSite)

+ func (c *Context) ShouldBind(obj interface{}) error

+ func (c *Context) ShouldBindBodyWith(obj interface{}, bb binding.BindingBody) (err error)

+ func (c *Context) ShouldBindHeader(obj interface{}) error

+ func (c *Context) ShouldBindJSON(obj interface{}) error

+ func (c *Context) ShouldBindQuery(obj interface{}) error

+ func (c *Context) ShouldBindUri(obj interface{}) error

+ func (c *Context) ShouldBindWith(obj interface{}, b binding.Binding) error

+ func (c *Context) ShouldBindXML(obj interface{}) error

+ func (c *Context) Status(code int)

+ func (c *Context) Stream(step func(w io.Writer) bool) bool

+ func (c *Context) String(code int, format string, values ...interface{})

+ func (c *Context) Value(key interface{}) interface{}

+ func (c *Context) XML(code int, obj interface{})

+ type Engine struct

+ AppEngine bool

+ ForwardedByClientIP bool

+ FuncMap template.FuncMap

+ HTMLRender render.HTMLRender

+ HandleMethodNotAllowed bool

+ MaxMultipartMemory int64

+ RedirectFixedPath bool

+ RedirectTrailingSlash bool

+ RemoteIPHeaders []string

+ RemoveExtraSlash bool

+ TrustedPlatform string

+ UnescapePathValues bool

+ UseRawPath bool

+ func Default() *Engine

+ func (engine *Engine) Delims(left, right string) *Engine

+ func (engine *Engine) HandleContext(c *Context)

+ func (engine *Engine) LoadHTMLFiles(files ...string)

+ func (engine *Engine) LoadHTMLGlob(pattern string)

+ func (engine *Engine) NoMethod(handlers ...HandlerFunc)

+ func (engine *Engine) NoRoute(handlers ...HandlerFunc)

+ func (engine *Engine) Routes() (routes RoutesInfo)

+ func (engine *Engine) Run(addr ...string) (err error)

+ func (engine *Engine) RunFd(fd int) (err error)

+ func (engine *Engine) RunListener(listener net.Listener) (err error)

+ func (engine *Engine) RunTLS(addr, certFile, keyFile string) (err error)

+ func (engine *Engine) RunUnix(file string) (err error)

+ func (engine *Engine) SecureJsonPrefix(prefix string) *Engine

+ func (engine *Engine) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ func (engine *Engine) SetFuncMap(funcMap template.FuncMap)

+ func (engine *Engine) SetHTMLTemplate(templ *template.Template)

+ func (engine *Engine) SetTrustedProxies(trustedProxies []string) error

+ func (engine *Engine) Use(middleware ...HandlerFunc) IRoutes

+ type Error struct

+ Err error

+ Meta interface{}

+ Type ErrorType

+ func (msg *Error) IsType(flags ErrorType) bool

+ func (msg *Error) JSON() interface{}

+ func (msg *Error) MarshalJSON() ([]byte, error)

+ func (msg *Error) SetMeta(data interface{}) *Error

+ func (msg *Error) SetType(flags ErrorType) *Error

+ func (msg *Error) Unwrap() error

+ func (msg Error) Error() string

+ type ErrorType uint64

+ const ErrorTypeAny

+ const ErrorTypeBind

+ const ErrorTypeNu

+ const ErrorTypePrivate

+ const ErrorTypePublic

+ const ErrorTypeRender

+ type H map[string]interface

+ func (h H) MarshalXML(e *xml.Encoder, start xml.StartElement) error

+ type HandlerFunc func(*Context)

+ func BasicAuth(accounts Accounts) HandlerFunc

+ func BasicAuthForRealm(accounts Accounts, realm string) HandlerFunc

+ func Bind(val interface{}) HandlerFunc

+ func CustomRecovery(handle RecoveryFunc) HandlerFunc

+ func CustomRecoveryWithWriter(out io.Writer, handle RecoveryFunc) HandlerFunc

+ func Recovery() HandlerFunc

+ func RecoveryWithWriter(out io.Writer, recovery ...RecoveryFunc) HandlerFunc

+ func WrapF(f http.HandlerFunc) HandlerFunc

+ func WrapH(h http.Handler) HandlerFunc

+ type HandlersChain []HandlerFunc

+ func (c HandlersChain) Last() HandlerFunc

+ type IRouter interface

+ Group func(string, ...HandlerFunc) *RouterGroup

+ type IRoutes interface

+ Any func(string, ...HandlerFunc) IRoutes

+ DELETE func(string, ...HandlerFunc) IRoutes

+ GET func(string, ...HandlerFunc) IRoutes

+ HEAD func(string, ...HandlerFunc) IRoutes

+ Handle func(string, string, ...HandlerFunc) IRoutes

+ OPTIONS func(string, ...HandlerFunc) IRoutes

+ PATCH func(string, ...HandlerFunc) IRoutes

+ POST func(string, ...HandlerFunc) IRoutes

+ PUT func(string, ...HandlerFunc) IRoutes

+ Static func(string, string) IRoutes

+ StaticFS func(string, http.FileSystem) IRoutes

+ StaticFile func(string, string) IRoutes

+ Use func(...HandlerFunc) IRoutes

+ type Negotiate struct

+ Data interface{}

+ HTMLData interface{}

+ HTMLName string

+ JSONData interface{}

+ Offered []string

+ XMLData interface{}

+ YAMLData interface{}

+ type Param struct

+ Key string

+ Value string

+ type Params []Param

+ func (ps Params) ByName(name string) (va string)

+ func (ps Params) Get(name string) (string, bool)

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

+ type ResponseWriter interface

+ Pusher func() http.Pusher

+ Size func() int

+ Status func() int

+ WriteHeaderNow func()

+ WriteString func(string) (int, error)

+ Written func() bool

+ type RouteInfo struct

+ Handler string

+ HandlerFunc HandlerFunc

+ Method string

+ Path string

+ type RouterGroup struct

+ Handlers HandlersChain

+ func (group *RouterGroup) Any(relativePath string, handlers ...HandlerFunc) IRoutes

+ func (group *RouterGroup) BasePath() string

+ func (group *RouterGroup) DELETE(relativePath string, handlers ...HandlerFunc) IRoutes

+ func (group *RouterGroup) GET(relativePath string, handlers ...HandlerFunc) IRoutes

+ func (group *RouterGroup) Group(relativePath string, handlers ...HandlerFunc) *RouterGroup

+ func (group *RouterGroup) HEAD(relativePath string, handlers ...HandlerFunc) IRoutes

+ func (group *RouterGroup) Handle(httpMethod, relativePath string, handlers ...HandlerFunc) IRoutes

+ func (group *RouterGroup) OPTIONS(relativePath string, handlers ...HandlerFunc) IRoutes

+ func (group *RouterGroup) PATCH(relativePath string, handlers ...HandlerFunc) IRoutes

+ func (group *RouterGroup) POST(relativePath string, handlers ...HandlerFunc) IRoutes

+ func (group *RouterGroup) PUT(relativePath string, handlers ...HandlerFunc) IRoutes

+ func (group *RouterGroup) Static(relativePath, root string) IRoutes

+ func (group *RouterGroup) StaticFS(relativePath string, fs http.FileSystem) IRoutes

+ func (group *RouterGroup) StaticFile(relativePath, filepath string) IRoutes

+ func (group *RouterGroup) Use(middleware ...HandlerFunc) IRoutes

+ type RoutesInfo []RouteInfo

v1.2.6

Jul 8, 2022

v1.2.5

Jun 29, 2022

v1.2.4

Jun 27, 2022

Changes in this version

type Api

+ func (a *Api) AddHealthCheckRouter()

+ func (a *Api) AddRateLimitMiddleware()

type Config

+ Middleware MiddlewareConfig

+ RateLimit uint64

+ Router RouterConfig

+ type MiddlewareConfig struct

+ Cors bool

+ RateLimit bool

+ type RouterConfig struct

+ HealthCheck bool

v1.2.3

Jun 20, 2022

v1.2.2

Jun 15, 2022

Changes in this version

+ func SetLog(log *zdpgo_log.Log)

type Api

+ func (a *Api) SetLog(log *zdpgo_log.Log)

v1.2.1

Jun 14, 2022

Changes in this version

type Api

+ func (a *Api) GetMd5(data string) string

type Context

+ func (c *Context) GetResponseSuccess(data interface{}) Response

v1.2.0

Jun 11, 2022

Changes in this version

type Context

+ func (c *Context) GetAesTextBodyToJson(jsonData interface{}) error

+ func (c *Context) ResponseAesStr(jsonResponse interface{})

v1.1.9

Jun 11, 2022

Changes in this version

type Context

+ func (c *Context) GetEccTextBodyToJson(jsonData interface{}) error

+ func (c *Context) ResponseEccStr(api *Api, jsonResponse interface{})

v1.1.8

Jun 6, 2022

Changes in this version

+ var Password *zdpgo_password.Password

type Api

+ Password *zdpgo_password.Password

type Config

+ Ecc EccConfig

type Context

+ func (c *Context) GetBody() ([]byte, error)

+ func (c *Context) GetEccBodyToJson(jsonData interface{}) error

+ type EccConfig struct

+ PrivateKey []byte

+ PublicKey []byte

+ type Response struct

+ Code int

+ Data interface{}

+ Msg string

+ Status bool

v1.1.7

May 17, 2022

Changes in this version

+ const AuthUserKey

+ var Log *zdpgo_log.Log

type Api

+ func (a *Api) Any(method, routerPath string, handleFuncList ...func(ctx *Context))

+ func (a *Api) Delete(routerPath string, handleFuncList ...func(ctx *Context))

+ func (a *Api) Get(routerPath string, handleFuncList ...func(ctx *Context))

+ func (a *Api) Patch(routerPath string, handleFuncList ...func(ctx *Context))

+ func (a *Api) Post(routerPath string, handleFuncList ...func(ctx *Context))

+ func (a *Api) Put(routerPath string, handleFuncList ...func(ctx *Context))

+ type ApiGroup struct

+ func (g *ApiGroup) Any(method, routerPath string, handleFuncList ...func(ctx *Context))

+ func (g *ApiGroup) Delete(routerPath string, handleFuncList ...func(ctx *Context))

+ func (g *ApiGroup) Get(routerPath string, handleFuncList ...func(ctx *Context))

+ func (g *ApiGroup) Patch(routerPath string, handleFuncList ...func(ctx *Context))

+ func (g *ApiGroup) Post(routerPath string, handleFuncList ...func(ctx *Context))

+ func (g *ApiGroup) Put(routerPath string, handleFuncList ...func(ctx *Context))

+ type Context struct

+ type JsonMap map[string]interface

+ type StringMap map[string]string

v1.1.6

May 17, 2022

Changes in this version

type Api

+ func (a *Api) AddStaticFSRouter(routerPath string, fsObj fs.FS)

+ func (a *Api) AddStaticRouter(routerPath string, dirPath string)

v1.1.5

May 17, 2022

v1.1.4

May 16, 2022

Changes in this version

+ type Api struct

+ App *gin.Engine

+ Config *Config

+ Log *zdpgo_log.Log

+ func New() *Api

+ func NewWithConfig(config Config) *Api

+ func (a *Api) AddCorsMiddleware()

+ func (a *Api) AddUploadRouter(routerPath string, fileName string, saveDir string, ...)

+ func (a *Api) CreateDirs(filePath string) error

+ func (a *Api) GetBasicAuthGroup(routerPath string, accounts map[string]string) (group *gin.RouterGroup)

+ func (a *Api) InitValidator() (err error)

+ func (a *Api) IsExists(path string) bool

+ func (a *Api) Run(exitFuncList ...func())

+ func (a *Api) SetApp(app *gin.Engine)

+ func (a *Api) Validate(data interface{}) (errData map[string]string)

+ type Config struct

+ Debug bool

+ Host string

+ LogFilePath string

+ Port int

+ UploadFileSize int64

v1.1.3

Apr 21, 2022

v1.1.2

Apr 11, 2022

v1.1.1

Apr 8, 2022

Changes in this version

+ func NewGinWithLog(isDetailLogger bool) *gin.Engine

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL