apis

Jun 10, 2024

Changes in this version

type ApiRoute

+ PreCache PreCache

+ type PreCache interface

+ Equal func(ctx *fasthttp.RequestCtx) (any, bool)

+ Save func(*fasthttp.RequestCtx, any)

Jun 4, 2024

Changes in this version

type ApiRoute

+ IsServerEvents bool

Mar 17, 2024

Changes in this version

+ func Indirect(kind reflect.Kind, value reflect.Value) (reflect.Kind, reflect.Value)

type DefValueCalcFnc

+ func (d DefValueCalcFnc) FormatDoc() string

type DefValueHeader

+ func (d DefValueHeader) FormatDoc() string

type Docs

+ FormatDoc func() string

type HeaderInParam

+ func (h *HeaderInParam) Flag(c int) bool

+ func (h *HeaderInParam) Precision() (prec int, ok bool)

+ func (h *HeaderInParam) Width() (wid int, ok bool)

+ func (h *HeaderInParam) Write(b []byte) (n int, err error)

Feb 16, 2024

Changes in this version

+ const AppStore

Dec 12, 2023

Changes in this version

+ type ErrMethodNotAllowed struct

+ func (e *ErrMethodNotAllowed) Error() string

type ErrorResp

+ func (e *ErrorResp) Error() string

Jul 25, 2023

Changes in this version

+ const IsWrapHandler

type DefValueCalcFnc

+ func (d DefValueCalcFnc) Expect() string

+ func (d DefValueCalcFnc) Format() string

+ func (d DefValueCalcFnc) RequestType() string

+ type DefValueHeader struct

+ func NewDefValueHeader(header, defValue string) DefValueHeader

+ func (d DefValueHeader) ConvertValue(ctx *fasthttp.RequestCtx) string

+ func (d DefValueHeader) Expect() string

+ func (d DefValueHeader) Format() string

+ func (d DefValueHeader) RequestType() string

+ type HeaderInParam struct

+ func (h *HeaderInParam) Encode(ptr unsafe.Pointer, stream *jsoniter.Stream)

+ func (h *HeaderInParam) IsEmpty(ptr unsafe.Pointer) bool

type MapRoutes

+ func NewMapRoutesWithAjaxWrap(endpoints []ApiRoutes, wrapHandler ApiRouteHandler, chgRoute func(*ApiRoute)) MapRoutes

Jun 15, 2023

Changes in this version

type ApiRoute

+ IsAJAXRequest bool

Jun 6, 2023

Changes in this version

+ func WriteCustomErrorResponse(ctx *fasthttp.RequestCtx, code int, err error, args map[string]string) (any, error)

Mar 30, 2023

Changes in this version

+ const ContentHandler

+ func WriteResponse(ctx *fasthttp.RequestCtx, resp any) (string, error)

Feb 16, 2023

Changes in this version

type Apis

+ StartTime time.Time

Jan 3, 2023

Changes in this version

+ func GetGraphSVG(ctx *fasthttp.RequestCtx, buf *bytes.Buffer) (any, error)

+ func HandlerForPreflightedCORS(ctx *fasthttp.RequestCtx) (any, error)

Oct 20, 2022

Changes in this version

+ const ServerName

+ const ServerVersion

+ const UNKNOWN

+ func Bearer(name, desc string) string

+ func NewqInParam(in string) *qInParam

+ func Schema(param InParam) string

+ func Security(desc string) string

+ func StreamBearer(qw422016 *qt422016.Writer, name, desc string)

+ func StreamSchema(qw422016 *qt422016.Writer, param InParam)

+ func StreamSecurity(qw422016 *qt422016.Writer, desc string)

+ func WriteBearer(qq422016 qtio422016.Writer, name, desc string)

+ func WriteSchema(qq422016 qtio422016.Writer, param InParam)

+ func WriteSecurity(qq422016 qtio422016.Writer, desc string)

+ type Docs interface

+ Expect func() string

+ Format func() string

+ RequestType func() string

type TypeInParam

+ func (t TypeInParam) StreamFormat(w *quicktemplate.Writer)

+ func (t TypeInParam) StreamRequestType(w *quicktemplate.Writer)

+ func (t TypeInParam) StreamTypeString(w *quicktemplate.Writer)

+ func (t TypeInParam) TypeString() string

Aug 30, 2022

Changes in this version

+ var ParamsEmail = InParam

+ var ParamsPassword = InParam

type InParam

+ func (param InParam) Format(s fmt.State, verb rune)

type TypeInParam

+ func (t TypeInParam) Format(s fmt.State, verb rune)

Aug 21, 2022

Changes in this version

+ var BasicParams = []InParam

+ var ParamsGetFormActions = InParam

+ var ParamsHTML = InParam

+ var ParamsLang = InParam

Aug 18, 2022

Changes in this version

+ const AuthManager

+ const Database

Aug 11, 2022

Changes in this version

+ const ContentTypeJSON

+ const ContentTypeMultiPart

Jul 1, 2022

Changes in this version

type InParam

+ func (param *InParam) WithNotRequired() *InParam

Jun 5, 2022

Changes in this version

type Apis

+ Https bool

+ func (apis Apis) DefaultRoutes() ApiRoutes

Mar 8, 2022

Changes in this version

+ const ApiVersion

+ const PARAM_REQUIRED

+ func NewSwaggerContent(schema map[string]interface{}) map[string]interface

+ func WriteMap(value reflect.Value, stream *jsoniter.Stream, title string) interface

+ func WriteReflectKind(kind reflect.Kind, value reflect.Value, stream *jsoniter.Stream, ...) interface

+ func WriteSlice(value reflect.Value, stream *jsoniter.Stream, title string) interface

+ func WriteStruct(value reflect.Value, stream *jsoniter.Stream, title string) interface

type InParam

+ func (param *InParam) Check(ctx *fasthttp.RequestCtx, badParams map[string]string)

+ type ReflectType struct

+ Props interface{}

+ func NewReflectType(value interface{}) *ReflectType

+ func (r *ReflectType) WriteMap(value reflect.Value, title string) interface{}

+ func (r *ReflectType) WriteReflectKind(kind reflect.Kind, value reflect.Value, sType, title string) interface{}

+ func (r *ReflectType) WriteSlice(value reflect.Value, title string) interface{}

+ func (r *ReflectType) WriteStruct(value reflect.Value, title string) interface{}

+ func (r ReflectType) CheckType(ctx *fasthttp.RequestCtx, value string) bool

+ func (r ReflectType) ConvertSlice(ctx *fasthttp.RequestCtx, values []string) (interface{}, error)

+ func (r ReflectType) ConvertValue(ctx *fasthttp.RequestCtx, value string) (interface{}, error)

+ func (r ReflectType) IsSlice() bool

+ type SwaggerParam map[string]interface

+ func NewSwaggerArray(desc string, props ...interface{}) SwaggerParam

+ func NewSwaggerArray1(props interface{}, name string) SwaggerParam

+ func NewSwaggerObject(props interface{}, name string) SwaggerParam

+ func NewSwaggerObjectRoot(props interface{}) SwaggerParam

+ func NewSwaggerParam(props interface{}, name, typ string) SwaggerParam

+ type SwaggerUnit struct

+ Items interface{}

+ Properties []spec.SchemaProps

+ Type string

Jan 5, 2022

Changes in this version

+ func WriteRecordAsJSON(ctx *fasthttp.RequestCtx, rowComma *string) func(values [][]byte, columns []dbEngine.Column) error

Dec 14, 2021

Changes in this version

+ func FirstObjectToJSON(stream *jsoniter.Stream, field string, s interface{})

+ func WriteElemValue(ctx *fasthttp.RequestCtx, src []byte, col dbEngine.Column)

type ApiRoute

+ FncIsForbidden func(ctx *fasthttp.RequestCtx) bool

+ WithCors bool

+ func NewAPIRouteWithDBEngine(desc string, method tMethod, needAuth bool, params []InParam, sqlOrName string, ...) *ApiRoute

+ func NewSimpleGETRoute(desc string, params []InParam, fnc ApiSimpleHandler, ...) *ApiRoute

+ func NewSimplePOSTRoute(desc string, params []InParam, fnc ApiSimpleHandler, ...) *ApiRoute

+ type ApiSimpleHandler func() (interface{}, error)

+ type ApisValues string

type BuildRouteOptions

+ func RouteNeedAuth() BuildRouteOptions

+ func RouteOnlyAdmin() BuildRouteOptions

+ type CheckDTO interface

+ CheckParams func(ctx *fasthttp.RequestCtx, badParams map[string]string) bool

+ type CompoundDTO interface

+ ReadParams func(ctx *fasthttp.RequestCtx)

+ type ErrorResp struct

+ FormErrors map[string]string

+ func NewErrorResp(formErrors map[string]string) *ErrorResp

+ func NewErrorRespBadDTO() *ErrorResp

+ type FncVisit func([]byte, *fastjson.Value)

type TypeInParam

+ DTO RouteDTO

+ func NewStructInParam(dto RouteDTO) TypeInParam

+ func (t TypeInParam) ReadValue(value string, v interface{}) (interface{}, error)

+ type Visit interface

+ Each func([]byte, *fastjson.Value)

+ Result func() (interface{}, error)

Jun 24, 2020

Changes in this version

+ const UNKNOW

+ type MapRoutes map[tMethod]map[string]*ApiRoute

+ func NewMapRoutes() MapRoutes

+ func (r MapRoutes) AddRoutes(routes ApiRoutes) (badRouting []string)

+ func (r MapRoutes) GetRoute(ctx *fasthttp.RequestCtx) (*ApiRoute, error)

+ func (r MapRoutes) GetTestRouteSuffix(route *ApiRoute) string

Oct 21, 2019

Changes in this version

type ApiRoute

+ OnlyAdmin bool

+ type FncAuth interface

+ AdminAuth func(ctx *fasthttp.RequestCtx) bool

+ Auth func(ctx *fasthttp.RequestCtx) bool

+ String func() string

Sep 21, 2019

Changes in this version

+ const CONNECT

+ const ChildRoutePath

+ const DELETE

+ const GET

+ const HEAD

+ const JSONParams

+ const MultiPartParams

+ const OPTIONS

+ const PATCH

+ const POST

+ const PUT

+ const TRACE

+ var ErrPathAlreadyExists = errors.New("this path already exists")

+ var ErrRouteForbidden = errors.New("not allow permission")

+ var ErrUnAuthorized = errors.New("user is UnAuthorized")

+ var ErrWrongParamsList = errors.New("wrong params list: %+v")

+ var HEADERS = map[string]string

+ func AddFieldToJSON(stream *jsoniter.Stream, field string, s string)

+ func AddObjectToJSON(stream *jsoniter.Stream, field string, s interface{})

+ func FirstFieldToJSON(stream *jsoniter.Stream, field string, s string)

+ func WriteHeaders(ctx *fasthttp.RequestCtx)

+ func WriteJSON(ctx *fasthttp.RequestCtx, r interface{}) (err error)

+ func WriteJSONHeaders(ctx *fasthttp.RequestCtx)

+ type APIRouteParamsType interface

+ CheckType func(ctx *fasthttp.RequestCtx, value string) bool

+ ConvertSlice func(ctx *fasthttp.RequestCtx, values []string) (interface{}, error)

+ ConvertValue func(ctx *fasthttp.RequestCtx, value string) (interface{}, error)

+ IsSlice func() bool

+ type ApiRoute struct

+ DTO RouteDTO

+ Desc string

+ Fnc ApiRouteHandler

+ FncAuth ApiRouteFuncAuth

+ Method tMethod

+ Multipart bool

+ NeedAuth bool

+ OnlyLocal bool

+ Params []InParam

+ Resp interface{}

+ TestFncAuth ApiRouteFuncAuth

+ func NewAPIRoute(desc string, method tMethod, params []InParam, needAuth bool, ...) *ApiRoute

+ func (route *ApiRoute) CheckAndRun(ctx *fasthttp.RequestCtx, fncAuth func(ctx *fasthttp.RequestCtx) bool) (resp interface{}, err error)

+ func (route *ApiRoute) CheckParams(ctx *fasthttp.RequestCtx) (badParams []string)

+ type ApiRouteFuncAuth func(ctx *fasthttp.RequestCtx) error

+ type ApiRouteHandler func(ctx *fasthttp.RequestCtx) (interface{}, error)

+ type ApiRoutes map[string]*ApiRoute

+ func NewAPIRoutes() ApiRoutes

+ func (r ApiRoutes) AddRoutes(routes ApiRoutes) (badRouting []string)

+ type Apis struct

+ Ctx CtxApis

+ func NewApis(ctx CtxApis, routes ApiRoutes, fncAuth func(ctx *fasthttp.RequestCtx) bool) *Apis

+ func (a *Apis) AddRoutes(routes ApiRoutes) (badRouting []string)

+ func (a *Apis) Handler(ctx *fasthttp.RequestCtx)

+ type ApisRender interface

+ WriteJSON func(ctx *fasthttp.RequestCtx, r interface{}) bool

+ type BuildRouteOptions func(route *ApiRoute)

+ func DTO(dto RouteDTO) BuildRouteOptions

+ func MultiPartForm() BuildRouteOptions

+ func OnlyLocal() BuildRouteOptions

+ func RouteAuth(fncAuth ApiRouteFuncAuth) BuildRouteOptions

+ type CtxApis map[string]interface

+ func (c CtxApis) AddValue(key string, val interface{})

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

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

+ func (c CtxApis) Err() error

+ func (c CtxApis) Value(key interface{}) interface{}

+ func NewCtxApis(cap int) CtxApis

+ type DefValueCalcFnc = func(ctx *fasthttp.RequestCtx) interface

+ type InParam struct

+ DefValue interface{}

+ Desc string

+ IncompatibleWiths []string

+ Name string

+ PartReq []string

+ Req bool

+ TestValue string

+ Type APIRouteParamsType

+ type RouteDTO interface

+ GetValue func() interface{}

+ NewValue func() interface{}

+ type TypeInParam struct

+ func NewSliceTypeInParam(bk types.BasicKind) TypeInParam

+ func NewTypeInParam(bk types.BasicKind) TypeInParam

+ func (t TypeInParam) CheckType(ctx *fasthttp.RequestCtx, value string) bool

+ func (t TypeInParam) ConvertSlice(ctx *fasthttp.RequestCtx, values []string) (interface{}, error)

+ func (t TypeInParam) ConvertValue(ctx *fasthttp.RequestCtx, value string) (interface{}, error)

+ func (t TypeInParam) IsSlice() bool

+ func (t TypeInParam) String() string