api

package

Go to main page

Versions in this module

v1

v1.1.5

Mar 31, 2025

Changes in this version

+ func BypassCORSCheck(next http.Handler) http.Handler

type Handler

+ func (handler Handler) WriteAckWithMessage(w http.ResponseWriter, ack bool, status int, msg string) error

+ func (handler Handler) WriteJSONBytes(w http.ResponseWriter, b []byte, statusCode int) error

+ func (handler Handler) WriteJavascriptHeader(w http.ResponseWriter)

type HandlerOptions

+ Action string

+ Features map[string]bool

+ Name string

+ RequirePermission []string

+ Resource string

+ func (option *HandlerOptions) Feature(feature string) bool

type Option

+ func Action(action string) Option

+ func Feature(feature string) Option

+ func Label(label string, v interface{}) Option

+ func Name(name string) Option

+ func RequirePermission(permissions ...string) Option

+ func Resource(source string) Option

v1.1.4

Mar 14, 2025

Changes in this version

+ func EncodeJSON(v interface{}) (b []byte, err error)

+ func RegisterUIFilter(filter UIFilters)

+ func WriteJSON(w http.ResponseWriter, v interface{}, statusCode int) error

type Handler

+ func (handler Handler) WriteErrorObject(w http.ResponseWriter, err interface{}, status int)

+ type HandlerOptions struct

+ Labels util.MapStr

+ LogRequest bool

+ OptionLogin bool

+ Permission string

+ RequireLogin bool

+ Tags []string

+ type Option func(*HandlerOptions)

+ func AllowPublicAccess() Option

+ func OptionLogin() Option

+ func Permission(permission string) Option

+ func RequireLogin() Option

+ type OptionRegistry struct

+ func NewOptionRegistry() *OptionRegistry

+ func (o OptionRegistry) Get(method Method, pattern string) (options *HandlerOptions, ok bool)

+ func (o OptionRegistry) GetKey(method Method, pattern string) string

+ func (o OptionRegistry) Register(method Method, pattern string, options *HandlerOptions)

+ type RegisteredAPIHandler struct

+ Handler func(w http.ResponseWriter, req *http.Request, ps httprouter.Params)

+ Options *HandlerOptions

+ type UIFilters interface

+ ApplyFilter func(method string, pattern string, options *HandlerOptions, next httprouter.Handle) httprouter.Handle

+ GetPriority func() int

v1.1.3

Feb 28, 2025

Changes in this version

+ func PrepareErrorJson(errMessage string, statusCode int) util.MapStr

v1.1.2

Feb 17, 2025

Changes in this version

type Handler

+ func (handler Handler) GetBoolOrDefault(r *http.Request, key string, defaultValue bool) bool

v1.1.0

Jan 11, 2025

Changes in this version

+ func GetFastHttpClient(name string) *fasthttp.Client

+ func GetHttpClient(name string) *http.Client

+ func UpdateProxyEnvironment(cfg *config.ProxyConfig)

type Handler

+ func (handler Handler) WriteBytes(w http.ResponseWriter, b []byte, statusCode int) error

v1.0.0

Dec 16, 2024

Changes in this version

+ var APIs = map[string]util.KV

+ var DefaultAPI = Handler

+ func AddGlobalInterceptors(interceptors ...Interceptor)

+ func AutoIssueTLSCertificates(tlsCfg *config.TLSConfig, cfg *tls.Config)

+ func BasicAuth(h httprouter.Handle, requiredUser, requiredPassword string) httprouter.Handle

+ func DestroySession(w http.ResponseWriter, r *http.Request) bool

+ func EnableAuth(enable bool)

+ func GetAppSetting(key string) interface

+ func GetAppSettings() util.MapStr

+ func GetClientTLSConfig(tlsConfig *config.TLSConfig) (*tls.Config, error)

+ func GetFlash(w http.ResponseWriter, r *http.Request) (bool, []interface{})

+ func GetServerTLSConfig(tlsCfg *config.TLSConfig) (*tls.Config, error)

+ func GetSession(r *http.Request, key string) (bool, interface{})

+ func GetSessionStore(r *http.Request, key string) (*sessions.Session, error)

+ func HandleAPIFunc(pattern string, handler func(http.ResponseWriter, *http.Request))

+ func HandleAPIMethod(method Method, pattern string, ...)

+ func HandleUI(pattern string, handler http.Handler)

+ func HandleUIFunc(pattern string, handler func(http.ResponseWriter, *http.Request))

+ func HandleUIMethod(method Method, pattern string, ...)

+ func HandleWebSocketCommand(command string, usage string, ...)

+ func IsAuthEnable() bool

+ func NewHTTPClient(clientCfg *config.HTTPClientConfig) (*http.Client, error)

+ func RecoveryHandler(opts ...RecoveryOption) func(h http.Handler) http.Handler

+ func RegisterAPIFilter(f filter.Filter)

+ func RegisterAppSetting(key string, v interface{})

+ func SetFlash(w http.ResponseWriter, r *http.Request, msg string) bool

+ func SetNotFoundHandler(handler func(rw http.ResponseWriter, r *http.Request))

+ func SetSession(w http.ResponseWriter, r *http.Request, key string, value interface{}) bool

+ func SimpleGetTLSConfig(tlsConfig *config.TLSConfig) *tls.Config

+ func StartAPI()

+ func StartWeb(cfg config.WebAppConfig)

+ func StopWeb(cfg config.WebAppConfig)

+ type AppSettings struct

+ func (settings *AppSettings) Add(key string, v interface{})

+ func (settings *AppSettings) Get(key string) interface{}

+ func (settings *AppSettings) GetSettingsMap() util.MapStr

+ type BasicAuthFilter struct

+ Password string

+ Username string

+ func (filter *BasicAuthFilter) FilterHttpHandlerFunc(pattern string, handler func(http.ResponseWriter, *http.Request)) func(http.ResponseWriter, *http.Request)

+ func (filter *BasicAuthFilter) FilterHttpRouter(pattern string, h httprouter.Handle) httprouter.Handle

+ type BasicTokenTransport struct

+ Token string

+ Transport http.RoundTripper

+ func (t *BasicTokenTransport) Client() *http.Client

+ func (t *BasicTokenTransport) RoundTrip(req *http.Request) (*http.Response, error)

+ type FoundResp struct

+ Found bool

+ Id string

+ Source interface{}

+ func FoundResponse(id string, data interface{}) FoundResp

+ func NotFoundResponse(id string) FoundResp

+ type Handler struct

+ func (handler Handler) DecodeJSON(r *http.Request, o interface{}) error

+ func (handler Handler) EncodeJSON(v interface{}) (b []byte, err error)

+ func (handler Handler) Error(w http.ResponseWriter, err error)

+ func (handler Handler) Error400(w http.ResponseWriter, msg string)

+ func (handler Handler) Error404(w http.ResponseWriter)

+ func (handler Handler) Error500(w http.ResponseWriter, msg string)

+ func (handler Handler) ErrorInternalServer(w http.ResponseWriter, msg string)

+ func (handler Handler) Flush(w http.ResponseWriter)

+ func (handler Handler) Get(req *http.Request, key string, defaultValue string) string

+ func (handler Handler) GetHeader(req *http.Request, key string, defaultValue string) string

+ func (handler Handler) GetIntOrDefault(r *http.Request, key string, defaultValue int) int

+ func (handler Handler) GetJSON(r *http.Request) (*jsonq.JsonQuery, error)

+ func (handler Handler) GetParameter(r *http.Request, key string) string

+ func (handler Handler) GetParameterOrDefault(r *http.Request, key string, defaultValue string) string

+ func (handler Handler) GetRawBody(r *http.Request) ([]byte, error)

+ func (handler Handler) MustGetParameter(w http.ResponseWriter, r *http.Request, key string) string

+ func (handler Handler) Redirect(w http.ResponseWriter, r *http.Request, url string)

+ func (handler Handler) Write(w http.ResponseWriter, b []byte) (int, error)

+ func (handler Handler) WriteAckJSON(w http.ResponseWriter, ack bool, status int, obj map[string]interface{}) error

+ func (handler Handler) WriteAckOKJSON(w http.ResponseWriter) error

+ func (handler Handler) WriteCreatedOKJSON(w http.ResponseWriter, id interface{}) error

+ func (handler Handler) WriteDeletedOKJSON(w http.ResponseWriter, id interface{}) error

+ func (handler Handler) WriteError(w http.ResponseWriter, errMessage string, statusCode int) error

+ func (handler Handler) WriteGetMissingJSON(w http.ResponseWriter, id string) error

+ func (handler Handler) WriteGetOKJSON(w http.ResponseWriter, id, obj interface{}) error

+ func (handler Handler) WriteHeader(w http.ResponseWriter, code int)

+ func (handler Handler) WriteJSON(w http.ResponseWriter, v interface{}, statusCode int) error

+ func (handler Handler) WriteJSONHeader(w http.ResponseWriter)

+ func (handler Handler) WriteJSONListResult(w http.ResponseWriter, total int64, v interface{}, statusCode int) error

+ func (handler Handler) WriteOKJSON(w http.ResponseWriter, v interface{}) error

+ func (handler Handler) WriteTextHeader(w http.ResponseWriter)

+ func (handler Handler) WriteUpdatedOKJSON(w http.ResponseWriter, id interface{}) error

+ type Interceptor interface

+ Match func(request *http.Request) bool

+ Name func() string

+ PostHandle func(c ctx.Context, writer http.ResponseWriter, request *http.Request)

+ PreHandle func(c ctx.Context, writer http.ResponseWriter, request *http.Request) (ctx.Context, error)

+ type InterceptorHandler struct

+ func NewInterceptorHandler() *InterceptorHandler

+ func (i *InterceptorHandler) AddInterceptors(interceptors ...Interceptor)

+ func (i *InterceptorHandler) Handler(handler http.Handler) http.Handler

+ type Method string

+ const DELETE

+ const GET

+ const HEAD

+ const OPTIONS

+ const POST

+ const PUT

+ func (method Method) String() string

+ type RecoveryOption func(http.Handler)

+ func PrintRecoveryStack(print bool) RecoveryOption

+ type Response struct

+ Hit interface{}

+ Id string

+ Result string

+ Total int64

+ func CreateResponse(id string) Response

+ func DeleteResponse(id string) Response

+ func UpdateResponse(id string) Response

+ type Result struct

+ Result interface{}

+ Total int64

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