echox

package module

Go to main page

Versions in this module

v0

v0.2.0

Mar 17, 2025

v0.1.2

Dec 1, 2024

v0.1.1

Nov 27, 2024

Changes in this version

type EchoParams

+ Logger *zap.Logger

v0.1.0

Nov 26, 2024

v0.0.9

Nov 25, 2024

v0.0.8

Nov 23, 2024

Changes in this version

+ func ExpressionSkipper(expressions ...string) middleware.Skipper

+ type Env struct

+ ContentLength int64

+ ContextValue func(name any) any

+ Cookies []*http.Cookie

+ EchoContextGet func(name string) any

+ FormValue func(name string) string

+ HandlerPath string

+ Headers map[string][]string

+ Host string

+ IsTLS bool

+ IsWebSocket bool

+ Method string

+ ParamNames []string

+ ParamValues []string

+ Pattern string

+ Proto string

+ QueryParams map[string][]string

+ QueryString string

+ RealIP string

+ RequestURI string

+ Scheme string

+ URL url.URL

v0.0.7

Nov 19, 2024

v0.0.6

Nov 19, 2024

Changes in this version

+ var DefaultAnnotations = []fx.Annotation

v0.0.5

Nov 19, 2024

Changes in this version

+ var OptionAPIAuthorizationMiddleware = fx.Provide(api.AsMiddleware(api.AuthorizationMiddleware))

v0.0.4

Nov 11, 2024

v0.0.3

Nov 8, 2024

Changes in this version

type Config

+ Router RouterConfig

+ type RouterConfig struct

+ Areas map[string]AreaConfig

+ Middlewares struct{ ... }

v0.0.2

Nov 7, 2024

v0.0.1

Nov 5, 2024

Changes in this version

+ const DecisionAllow

+ const DecisionDeny

+ var ErrDeny = errors.New("huma api: authorizer decision `deny`")

+ var OptionAuthorizationAPIMiddleware = fx.Provide(AsAPIMiddleware(AuthorizationAPIMiddleware))

+ var OptionAuthorizationChecker = fx.Provide(func(rbac *rbac.RBAC) rbac.AuthorizationChecker { ... })

+ var OptionAuthorizationMiddleware = fx.Provide(AsMiddleware(AuthorizationMiddleware))

+ var OptionAuthorizer = fx.Provide(fx.Annotate(NewDefaultAuthorizer, fx.As(new(Authorizer))))

+ var OptionBasicAuthMiddleware = fx.Provide(AsMiddleware(BasicAuthMiddleware))

+ var OptionBearerAuthMiddleware = fx.Provide(AsMiddleware(BearerAuthMiddleware))

+ var OptionBodyLimitMiddleware = fx.Provide(AsMiddleware(BodyLimitMiddleware))

+ var OptionCORSMiddleware = fx.Provide(AsMiddleware(CORSMiddleware))

+ var OptionCSRFMiddleware = fx.Provide(AsMiddleware(CSRFMiddleware))

+ var OptionCompressMiddleware = fx.Provide(AsMiddleware(CompressMiddleware))

+ var OptionDecompressMiddleware = fx.Provide(AsMiddleware(DecompressMiddleware))

+ var OptionEcho = fx.Provide(NewEcho)

+ var OptionIPExtractor = fx.Provide(IPExtractor)

+ var OptionLoggerMiddleware = fx.Provide(AsMiddleware(LoggerMiddleware))

+ var OptionRBAC = fx.Provide(rbac.New)

+ var OptionRBACWithConfig = fx.Provide(rbac.NewWithConfig)

+ var OptionRecoverMiddleware = fx.Provide(AsMiddleware(RecoverMiddleware))

+ var OptionRequestIDMiddleware = fx.Provide(AsMiddleware(RequestIDMiddleware))

+ var OptionSecureMiddleware = fx.Provide(AsMiddleware(SecureMiddleware))

+ var OptionSessionManager = fx.Provide(NewSessionManager)

+ var OptionSessionMiddleware = fx.Provide(AsMiddleware(SessionMiddleware))

+ func AsAPIHandler(f any) any

+ func AsAPIMiddleware(middleware any) any

+ func AsAPIMiddlewareFunc(name string, ...) any

+ func AsHandler(f any) any

+ func AsMiddleware(middleware any) any

+ func AsMiddlewareFunc(name string, middleware echo.MiddlewareFunc) any

+ func ChainSkipper(skippers ...middleware.Skipper) middleware.Skipper

+ func CheckMethod(method, skip string) (string, bool)

+ func CtxArea(ctx context.Context) string

+ func CtxAssertions(ctx context.Context) []rbac.Assertion

+ func EqualPathSkipper(paths ...string) middleware.Skipper

+ func IPExtractor() echo.IPExtractor

+ func NewEcho(params EchoParams) *echo.Echo

+ func NewSessionManager(params SessionManagerParams) *scs.SessionManager

+ func PrefixPathSkipper(prefixes ...string) middleware.Skipper

+ func SuffixPathSkipper(suffixes ...string) middleware.Skipper

+ func WithAssertions(ctx context.Context, assertions ...rbac.Assertion) context.Context

+ func WithClaims(ctx context.Context, claims *Claims) context.Context

+ type APIConfig struct

+ Components huma.Components

+ DocsPath string

+ Enabled bool

+ Info huma.Info

+ Middlewares []string

+ OpenAPIPath string

+ Path string

+ SchemasPath string

+ func (cfg *APIConfig) InitDefaults()

+ type APIHandler interface

+ Area func() string

+ Register func(*echo.Echo, huma.API)

+ Version func() string

+ type APIMiddleware struct

+ Middleware func(huma.API) func(huma.Context, func(huma.Context))

+ Name string

+ func AuthorizationAPIMiddleware(authorizer Authorizer, logger *zap.Logger) APIMiddleware

+ func NewAPIMiddleware(name string, middleware func(huma.API) func(huma.Context, func(huma.Context))) APIMiddleware

+ type AreaConfig struct

+ API map[string]APIConfig

+ Additional map[string]any

+ Enabled bool

+ Middlewares []string

+ Path string

+ func (cfg *AreaConfig) InitDefaults()

+ type Authorizer interface

+ Authorize func(ctx context.Context, claims *Claims, target *Target) (Decision, error)

+ type BodyLimitConfig struct

+ Limit string

+ Skipper middleware.Skipper

+ func (cfg *BodyLimitConfig) InitDefaults()

+ type CORSConfig struct

+ AllowCredentials bool

+ AllowHeaders []string

+ AllowMethods []string

+ AllowOriginFunc func(origin string) (bool, error)

+ AllowOrigins []string

+ ExposeHeaders []string

+ MaxAge int

+ Skipper middleware.Skipper

+ UnsafeWildcardOriginWithAllowCredentials bool

+ type CSRFConfig struct

+ ContextKey string

+ Cookie struct{ ... }

+ ErrorHandler middleware.CSRFErrorHandler

+ Skipper middleware.Skipper

+ TokenLength uint8

+ TokenLookup string

+ type Claims struct

+ Metadata map[string]any

+ Subject Subject

+ func CtxClaims(ctx context.Context) *Claims

+ type Config struct

+ Areas map[string]AreaConfig

+ Middlewares MiddlewaresConfig

+ Security rbac.Config

+ func (cfg *Config) InitDefaults()

+ type Decision int8

+ func (d Decision) String() string

+ type DefaultAuthorizer struct

+ func NewDefaultAuthorizer(rbac *rbac.RBAC) *DefaultAuthorizer

+ func (a *DefaultAuthorizer) Authorize(ctx context.Context, claims *Claims, target *Target) (d Decision, err error)

+ type EchoParams struct

+ APIHandlers []APIHandler

+ APIMiddlewares []APIMiddleware

+ Config Config

+ ErrorHandler echo.HTTPErrorHandler

+ Filesystem fs.FS

+ Handlers []Handler

+ IPExtractor echo.IPExtractor

+ Middlewares []Middleware

+ Renderer echo.Renderer

+ Validator echo.Validator

+ type GzipConfig struct

+ Level int

+ MinLength int

+ Skipper middleware.Skipper

+ func (cfg *GzipConfig) InitDefaults()

+ type Handler interface

+ Area func() string

+ Register func(*echo.Echo, *echo.Group)

+ type Middleware struct

+ Middleware echo.MiddlewareFunc

+ Name string

+ func AuthorizationMiddleware(authorizer Authorizer) Middleware

+ func BasicAuthMiddleware(validator middleware.BasicAuthValidator) Middleware

+ func BearerAuthMiddleware(validator middleware.KeyAuthValidator) Middleware

+ func BodyLimitMiddleware(cfg BodyLimitConfig) Middleware

+ func CORSMiddleware(cfg CORSConfig) Middleware

+ func CSRFMiddleware(cfg CSRFConfig) Middleware

+ func CompressMiddleware(cfg GzipConfig) Middleware

+ func DecompressMiddleware() Middleware

+ func LoggerMiddleware(cfg RequestLoggerConfig, logger *zap.Logger) Middleware

+ func NewMiddleware(name string, middleware echo.MiddlewareFunc) Middleware

+ func RecoverMiddleware(cfg RecoverConfig, logger *zap.Logger) Middleware

+ func RequestIDMiddleware() Middleware

+ func SecureMiddleware(cfg SecureConfig) Middleware

+ func SessionMiddleware(cfg SessionConfig, sessionManager *scs.SessionManager) Middleware

+ type MiddlewaresConfig struct

+ BodyLimit BodyLimitConfig

+ CORS CORSConfig

+ CSRF CSRFConfig

+ Compress GzipConfig

+ Logger RequestLoggerConfig

+ Recover RecoverConfig

+ Router struct{ ... }

+ Secure SecureConfig

+ Session SessionConfig

+ func (cfg *MiddlewaresConfig) InitDefaults()

+ type RecoverConfig struct

+ DisableStackAll bool

+ Skipper middleware.Skipper

+ StackSize int

+ type RequestLoggerConfig struct

+ AdditionalFieldsFunc func(echo.Context) []zap.Field

+ HandleError bool

+ LogContentLength bool

+ LogError bool

+ LogFormValues []string

+ LogHeaders []string

+ LogHost bool

+ LogLatency bool

+ LogMethod bool

+ LogProtocol bool

+ LogQueryParams []string

+ LogReferer bool

+ LogRemoteIP bool

+ LogRequestID bool

+ LogResponseSize bool

+ LogRoutePath bool

+ LogStatus bool

+ LogURI bool

+ LogURIPath bool

+ LogUserAgent bool

+ Skipper middleware.Skipper

+ type RoleHierarchyConfig struct

+ Children []string

+ Parents []string

+ Role string

+ type SameSiteType string

+ const SameSiteDefault

+ const SameSiteLax

+ const SameSiteNone

+ const SameSiteStrict

+ func (s SameSiteType) HTTP() http.SameSite

+ type SecureConfig struct

+ CSPReportOnly bool

+ ContentSecurityPolicy string

+ ContentTypeNosniff string

+ HSTSExcludeSubdomains bool

+ HSTSMaxAge int

+ HSTSPreloadEnabled bool

+ ReferrerPolicy string

+ Skipper middleware.Skipper

+ XFrameOptions string

+ XSSProtection string

+ func (cfg *SecureConfig) InitDefaults()

+ type SessionConfig struct

+ CleanupInterval time.Duration

+ Cookie struct{ ... }

+ IdleTimeout time.Duration

+ Lifetime time.Duration

+ Skipper middleware.Skipper

+ type SessionManagerParams struct

+ Config SessionConfig

+ Store scs.Store

+ type Subject interface

+ Identifier func() string

+ Roles func() []string

+ type Target struct

+ Action string

+ Assertions []rbac.Assertion

+ Metadata map[string]any

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