azugo

Oct 23, 2024

Changes in this version

type BadRequestError

+ Err error

+ func (e BadRequestError) SafeError() string

Sep 9, 2024

Changes in this version

type Context

+ func (c *Context) MaxPageSize() int

+ func (c *Context) SetMaxPageSize(maxPageSize int)

Aug 30, 2024

Changes in this version

type ProxyOptions

+ TrustedHeaders []string

Jun 18, 2024

Changes in this version

type HeaderCtx

+ func (h *HeaderCtx) InheritAuthorization() http.RequestOption

Jun 17, 2024

Changes in this version

type Context

+ func RequestContext(ctx context.Context) *Context

+ type Contexter interface

+ RequestContext func() context.Context

Jun 6, 2024

Changes in this version

+ func InstrRequest(op string, args ...any) (string, bool)

type App

+ func (a *App) AddHTTPClientOption(opt http.Option)

+ func (a *App) HTTPClient() http.Client

+ func (a *App) StaticEmbedded(path string, f embed.FS, opts ...StaticOption) error

type Context

+ func (c *Context) HTTPClient() http.Client

+ func (c *Context) Stream(r io.Reader)

type HeaderCtx

+ func (h *HeaderCtx) Keys() []string

+ type StaticDirTrimPrefix string

+ type StaticOption interface

Sep 13, 2023

Changes in this version

type CORSOptions

+ func (c *CORSOptions) AllowCredentials() bool

+ type UnprocessableEntityError struct

+ Description string

+ func (e UnprocessableEntityError) Error() string

+ func (e UnprocessableEntityError) StatusCode() int

Apr 4, 2023

Changes in this version

+ const ContentTypeOctetStream

+ const HeaderContentDisposition

+ const HeaderContentTransferEncoding

+ const HeaderContentType

type UserGrantedScopes

+ HasScopeAnyLevel func(name string, levels ...string) bool

Mar 21, 2023

Changes in this version

+ type BadRequestError struct

+ Description string

+ func (e BadRequestError) Error() string

+ func (e BadRequestError) StatusCode() int

+ type ForbiddenError struct

+ func (e ForbiddenError) Error() string

+ func (e ForbiddenError) StatusCode() int

+ type NotFoundError struct

+ Resource string

+ func (e NotFoundError) Error() string

+ func (e NotFoundError) StatusCode() int

+ type ParamInvalidError struct

+ Err error

+ Name string

+ Tag string

+ func (e ParamInvalidError) Error() string

+ func (e ParamInvalidError) SafeError() string

+ func (e ParamInvalidError) StatusCode() int

+ type ParamRequiredError struct

+ Name string

+ func (e ParamRequiredError) Error() string

+ func (e ParamRequiredError) SafeError() string

+ func (e ParamRequiredError) StatusCode() int

Feb 6, 2023

Changes in this version

type ParamsCtx

+ func (p *ParamsCtx) Has(key string) bool

Dec 6, 2022

Changes in this version

type Context

+ func (ctx *Context) AddLogFields(fields ...zap.Field) error

+ func (ctx *Context) ID() string

+ func (ctx *Context) ReplaceLogger(logger *zap.Logger) error

+ func (ctx *Context) SkipRequestLog()

Nov 14, 2022

Changes in this version

type TestClient

+ func (c *TestClient) Client() *fasthttp.Client

Oct 27, 2022

Changes in this version

type User

+ ID func() string

Oct 25, 2022

Changes in this version

+ type UserAuthorizer interface

+ Authorized func() bool

type UserDisplayNamer

+ FamilyName func() string

+ GivenName func() string

+ type UserGrantedScopes interface

+ HasScope func(name string) bool

+ HasScopeGroup func(name string) bool

+ HasScopeLevel func(name string, level string) bool

Oct 18, 2022

Changes in this version

type App

+ func (a *App) ApplyConfig()

+ func (a *App) SetRouterSwitch(r RouteSwitcher)

type Context

+ func (ctx *Context) RouterOptions() *RouterOptions

type RouteGroup

+ func (g *RouteGroup) Mutable(v bool)

+ type RouteSwitcher interface

+ SelectRouter func(ctx *fasthttp.RequestCtx) RouterHandler

+ type Router interface

+ Any func(path string, handler RequestHandler)

+ Connect func(path string, handler RequestHandler)

+ Delete func(path string, handler RequestHandler)

+ Get func(path string, handler RequestHandler)

+ Group func(path string) Router

+ Handle func(method, path string, handler RequestHandler)

+ Head func(path string, handler RequestHandler)

+ Mutable func(v bool)

+ Options func(path string, handler RequestHandler)

+ Patch func(path string, handler RequestHandler)

+ Post func(path string, handler RequestHandler)

+ Proxy func(path string, options ...ProxyOption)

+ Put func(path string, handler RequestHandler)

+ Trace func(path string, handler RequestHandler)

+ Use func(middlewares ...RequestHandlerFunc)

+ type RouterHandler interface

+ Handler func(ctx *fasthttp.RequestCtx)

+ func NewRouter(app *App) RouterHandler

type RouterOptions

+ BasePath string

+ func (r *RouterOptions) ApplyConfig(conf *config.Configuration)

type TestClient

+ func (c *TestClient) WithHost(host string) TestClientOption

Sep 12, 2022

Changes in this version

+ const InstrumentationRequest

Sep 8, 2022

Changes in this version

+ const ContentTypeJSON

+ const ContentTypeXML

+ const DefaultMetricPath

+ const HeaderAccept

+ const HeaderAccessControlExposeHeaders

+ const HeaderLink

+ const HeaderTotalCount

+ const MethodWild

+ type App struct

+ MetricsOptions MetricsOptions

+ RouterOptions RouterOptions

+ ServerOptions ServerOptions

+ func New() *App

+ func (a *App) Any(path string, handler RequestHandler)

+ func (a *App) Config() *config.Configuration

+ func (a *App) Connect(path string, handler RequestHandler)

+ func (a *App) Delete(path string, handler RequestHandler)

+ func (a *App) Get(path string, handler RequestHandler)

+ func (a *App) Group(path string) *RouteGroup

+ func (a *App) Handle(method, path string, handler RequestHandler)

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

+ func (a *App) Head(path string, handler RequestHandler)

+ func (a *App) Mutable(v bool)

+ func (a *App) Options(path string, handler RequestHandler)

+ func (a *App) Patch(path string, handler RequestHandler)

+ func (a *App) Post(path string, handler RequestHandler)

+ func (a *App) Proxy(path string, options ...ProxyOption)

+ func (a *App) Put(path string, handler RequestHandler)

+ func (a *App) Routes() map[string][]string

+ func (a *App) SetConfig(cmd *cobra.Command, conf *config.Configuration)

+ func (a *App) Start() error

+ func (a *App) Trace(path string, handler RequestHandler)

+ func (a *App) Use(middlewares ...RequestHandlerFunc)

+ type BodyCtx struct

+ func (b *BodyCtx) Bytes() []byte

+ func (b *BodyCtx) JSON(v any) error

+ func (b *BodyCtx) WriteTo(w io.Writer) error

+ func (b *BodyCtx) XML(v any) error

+ type CORSOptions struct

+ func (c *CORSOptions) Headers() string

+ func (c *CORSOptions) Methods() string

+ func (c *CORSOptions) SetHeaders(headers ...string) *CORSOptions

+ func (c *CORSOptions) SetMethods(methods ...string) *CORSOptions

+ func (c *CORSOptions) SetOrigins(origins ...string) *CORSOptions

+ func (c *CORSOptions) ValidOrigin(origin string) bool

+ type ClaimStrings []string

+ func (s *ClaimStrings) UnmarshalJSON(data []byte) (err error)

+ func (s ClaimStrings) MarshalJSON() (b []byte, err error)

+ func (s ClaimStrings) Value() string

+ type Context struct

+ Body BodyCtx

+ Form FormCtx

+ Header HeaderCtx

+ Params ParamsCtx

+ Query QueryCtx

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

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

+ func (c *Context) Err() error

+ func (c *Context) Value(key any) any

+ func (ctx *Context) Accepts(contentType string) bool

+ func (ctx *Context) AcceptsExplicit(contentType string) bool

+ func (ctx *Context) App() *App

+ func (ctx *Context) BasePath() string

+ func (ctx *Context) BaseURL() string

+ func (ctx *Context) ContentType(contentType string, charset ...string) *Context

+ func (ctx *Context) Context() *fasthttp.RequestCtx

+ func (ctx *Context) Env() core.Environment

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

+ func (ctx *Context) Host() string

+ func (ctx *Context) IP() net.IP

+ func (ctx *Context) IsTLS() bool

+ func (ctx *Context) IsTrustedProxy() bool

+ func (ctx *Context) JSON(obj any)

+ func (ctx *Context) Log() *zap.Logger

+ func (ctx *Context) Method() string

+ func (ctx *Context) NotFound()

+ func (ctx *Context) Paging() *paginator.Paginator

+ func (ctx *Context) Path() string

+ func (ctx *Context) Raw(data []byte)

+ func (ctx *Context) Redirect(url string)

+ func (ctx *Context) Request() *fasthttp.Request

+ func (ctx *Context) Response() *fasthttp.Response

+ func (ctx *Context) RouterPath() string

+ func (ctx *Context) SetPaging(values map[string]string, paginator *paginator.Paginator)

+ func (ctx *Context) SetUser(u User)

+ func (ctx *Context) SetUserValue(name string, value any)

+ func (ctx *Context) StatusCode(status int) *Context

+ func (ctx *Context) Text(text string)

+ func (ctx *Context) User() User

+ func (ctx *Context) UserAgent() string

+ func (ctx *Context) UserValue(name string) any

+ func (ctx *Context) Validate() *validation.Validate

+ type ErrParamInvalid struct

+ Err error

+ Name string

+ Tag string

+ func (e ErrParamInvalid) Error() string

+ func (e ErrParamInvalid) SafeError() string

+ func (e ErrParamInvalid) StatusCode() int

+ type ErrParamRequired struct

+ Name string

+ func (e ErrParamRequired) Error() string

+ func (e ErrParamRequired) SafeError() string

+ func (e ErrParamRequired) StatusCode() int

+ type ErrorResponse struct

+ Errors []*ErrorResponseError

+ func NewErrorResponse(err error) *ErrorResponse

+ type ErrorResponseError struct

+ Message string

+ Type string

+ type FormCtx struct

+ func (f *FormCtx) Bool(key string) (bool, error)

+ func (f *FormCtx) BoolOptional(key string) (*bool, error)

+ func (f *FormCtx) File(key string) (*multipart.FileHeader, error)

+ func (f *FormCtx) FileOptional(key string) *multipart.FileHeader

+ func (f *FormCtx) Files(key string) []*multipart.FileHeader

+ func (f *FormCtx) Int(key string) (int, error)

+ func (f *FormCtx) Int64(key string) (int64, error)

+ func (f *FormCtx) Int64Optional(key string) (*int64, error)

+ func (f *FormCtx) IntOptional(key string) (*int, error)

+ func (f *FormCtx) String(key string) (string, error)

+ func (f *FormCtx) StringOptional(key string) *string

+ func (f *FormCtx) Values(key string) []string

+ type Handler interface

+ Handler func(*Context)

+ type HeaderCtx struct

+ func (h *HeaderCtx) Add(key, value string)

+ func (h *HeaderCtx) AppendAccessControlExposeHeaders(names ...string)

+ func (h *HeaderCtx) Del(key string)

+ func (h *HeaderCtx) Get(key string) string

+ func (h *HeaderCtx) Set(key, value string)

+ func (h *HeaderCtx) Values(key string) []string

+ type MetricsOptions struct

+ SkipPaths []string

+ TrustAll bool

+ TrustedIPs []net.IP

+ TrustedNetworks []*net.IPNet

+ func (opts *MetricsOptions) Add(ipnet string) *MetricsOptions

+ func (opts *MetricsOptions) Clear() *MetricsOptions

+ type ParamsCtx struct

+ func (p *ParamsCtx) Int(key string) (int, error)

+ func (p *ParamsCtx) Int64(key string) (int64, error)

+ func (p *ParamsCtx) String(key string) string

+ type Proxy struct

+ func (p *Proxy) Handler(ctx *Context)

+ type ProxyOption interface

+ func ProxyUpstream(upstream ...*url.URL) ProxyOption

+ func ProxyUpstreamBodyReplaceText(from, to string) ProxyOption

+ type ProxyOptions struct

+ ForwardLimit int

+ TrustAll bool

+ TrustedIPs []net.IP

+ TrustedNetworks []*net.IPNet

+ func (opts *ProxyOptions) Add(ipnet string) *ProxyOptions

+ func (opts *ProxyOptions) Clear() *ProxyOptions

+ type ProxyUpstreamBodyReplaceURL bool

+ type ProxyUpstreamInsecureSkipVerify bool

+ type QueryCtx struct

+ func (q *QueryCtx) Bool(key string) (bool, error)

+ func (q *QueryCtx) BoolOptional(key string) (*bool, error)

+ func (q *QueryCtx) Int(key string) (int, error)

+ func (q *QueryCtx) Int64(key string) (int64, error)

+ func (q *QueryCtx) Int64Optional(key string) (*int64, error)

+ func (q *QueryCtx) IntOptional(key string) (*int, error)

+ func (q *QueryCtx) String(key string) (string, error)

+ func (q *QueryCtx) StringOptional(key string) *string

+ func (q *QueryCtx) Values(key string) []string

+ type RequestHandler func(ctx *Context)

+ func Handle(h Handler) RequestHandler

+ type RequestHandlerFunc func(h RequestHandler) RequestHandler

+ type ResponseStatusCode interface

+ StatusCode func() int

+ type RouteGroup struct

+ func (g *RouteGroup) Any(path string, handler RequestHandler)

+ func (g *RouteGroup) Connect(path string, handler RequestHandler)

+ func (g *RouteGroup) Delete(path string, handler RequestHandler)

+ func (g *RouteGroup) Get(path string, handler RequestHandler)

+ func (g *RouteGroup) Group(path string) *RouteGroup

+ func (g *RouteGroup) Handle(method, path string, handler RequestHandler)

+ func (g *RouteGroup) Head(path string, handler RequestHandler)

+ func (g *RouteGroup) Options(path string, handler RequestHandler)

+ func (g *RouteGroup) Patch(path string, handler RequestHandler)

+ func (g *RouteGroup) Post(path string, handler RequestHandler)

+ func (g *RouteGroup) Proxy(path string, options ...ProxyOption)

+ func (g *RouteGroup) Put(path string, handler RequestHandler)

+ func (g *RouteGroup) Trace(path string, handler RequestHandler)

+ func (g *RouteGroup) Use(middleware ...RequestHandlerFunc)

+ type RouterOptions struct

+ CORS CORSOptions

+ ErrorHandler func(*Context, error)

+ GlobalOPTIONS RequestHandler

+ HandleMethodNotAllowed bool

+ HandleOPTIONS bool

+ Host string

+ MethodNotAllowed RequestHandler

+ NotFound RequestHandler

+ PanicHandler func(*Context, any)

+ Proxy ProxyOptions

+ RedirectFixedPath bool

+ RedirectTrailingSlash bool

+ type SafeError interface

+ SafeError func() string

+ type ServerOptions struct

+ RequestReadBufferSize int

+ ResponseWriteBufferSize int

+ type StandardUser struct

+ Authorized bool

+ Claims map[string]ClaimStrings

+ ID string

+ func NewStandardUser() *StandardUser

+ func (u *StandardUser) Claim(name ...string) ClaimStrings

+ func (u *StandardUser) ClaimValue(name ...string) string

+ func (u *StandardUser) DisplayName() string

+ type TestApp struct

+ func NewTestApp(app ...*App) *TestApp

+ func (a *TestApp) Start(t *testing.T)

+ func (a *TestApp) StartBenchmark()

+ func (a *TestApp) Stop()

+ func (a *TestApp) TestClient() *TestClient

+ type TestClient struct

+ func (c *TestClient) Call(method, endpoint string, body []byte, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) CallRaw(method, endpoint, body []byte, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) Connect(endpoint string, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) Delete(endpoint string, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) Get(endpoint string, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) Head(endpoint string, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) Options(endpoint string, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) Patch(endpoint string, body []byte, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) PatchForm(endpoint string, params map[string]any, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) PatchJSON(endpoint string, body any, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) PatchMultiPartForm(endpoint string, form *multipart.Form, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) Post(endpoint string, body []byte, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) PostForm(endpoint string, params map[string]any, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) PostJSON(endpoint string, body any, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) PostMultiPartForm(endpoint string, form *multipart.Form, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) Put(endpoint string, body []byte, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) PutForm(endpoint string, params map[string]any, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) PutJSON(endpoint string, body any, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) PutMultiPartForm(endpoint string, form *multipart.Form, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) Trace(endpoint string, options ...TestClientOption) (*fasthttp.Response, error)

+ func (c *TestClient) WithHeader(key, value string) TestClientOption

+ func (c *TestClient) WithMultiPartFormBoundary(boundary string) TestClientOption

+ func (c *TestClient) WithQuery(params map[string]any) TestClientOption

+ type TestClientOption func(*TestClient, *fasthttp.Request)

+ type User interface

+ type UserClaimer interface

+ Claim func(name ...string) ClaimStrings

+ ClaimValue func(name ...string) string

+ type UserDisplayNamer interface

+ DisplayName func() string

+ type UserRighter interface

+ HasRight func(right string) bool

+ HasRightGroup func(group string) bool

+ HasRightLevel func(right string, level string) bool

+ type Validator interface

+ Validate func(ctx *Context) error