app

package module

Go to main page

Versions in this module

v0

v0.21.0

Mar 24, 2026

v0.20.0

Mar 19, 2026

Changes in this version

type App

+ func (a *App) ValidateRoutes() error

type ConfigError

+ Hint string

+ type ConfigErrors struct

+ Errors []*ConfigError

+ func (ce *ConfigErrors) Add(err *ConfigError)

+ func (ce *ConfigErrors) Error() string

+ func (ce *ConfigErrors) HasErrors() bool

+ func (ce *ConfigErrors) ToError() error

type Context

+ func TestContextWithBodyAndApp(a *App, method, path string, body any) (*Context, error)

+ func (c *Context) CopyTraceContext() context.Context

+ func (c *Context) FinishSpanWithError(span trace.Span, err error)

+ func (c *Context) FinishSpanWithHTTPStatus(span trace.Span, statusCode int)

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

+ func (c *Context) WithSpan(name string, fn func(context.Context) error) error

type Option

+ func WithErrorFormatterFor(mediaType string, opts ...errors.Option) Option

+ func WithValidationEngine(engine *validation.Engine) Option

+ type ValidateOption func(*validateConfig)

+ func WithValidateOptions(opts ...validation.Option) ValidateOption

+ func WithValidatePartial() ValidateOption

+ func WithValidateStrict() ValidateOption

v0.19.0

Mar 14, 2026

Changes in this version

type Context

+ func (c *Context) AddCounter(name string, value int64, attributes ...attribute.KeyValue)

+ func (c *Context) FinishSpan(span trace.Span, statusCode int)

+ func (c *Context) StartSpan(name string, opts ...trace.SpanStartOption) (context.Context, trace.Span)

+ func (c *Context) Tracer() *tracing.Tracer

v0.18.1

Mar 12, 2026

v0.18.0

Mar 12, 2026

Changes in this version

+ const DefaultTLSPort

+ var ErrRouterFrozen = errors.New("cannot register hooks after router is frozen")

+ type AccessLogScope string

+ const AccessLogScopeAll

+ const AccessLogScopeErrorsOnly

type ObservabilityOption

+ func WithAccessLogScope(scope AccessLogScope) ObservabilityOption

type Option

+ func WithMTLS(serverCert tls.Certificate, opts ...MTLSOption) Option

+ func WithTLS(certFile, keyFile string) Option

v0.17.0

Feb 27, 2026

Changes in this version

type Context

+ func (c *Context) AddSpanEvent(name string, attrs ...attribute.KeyValue)

+ func (c *Context) IncrementCounter(name string, attributes ...attribute.KeyValue)

+ func (c *Context) RecordHistogram(name string, value float64, attributes ...attribute.KeyValue)

+ func (c *Context) SetGauge(name string, value float64, attributes ...attribute.KeyValue)

+ func (c *Context) SetSpanAttribute(key string, value any)

+ func (c *Context) Span() trace.Span

+ func (c *Context) SpanID() string

+ func (c *Context) TraceContext() context.Context

+ func (c *Context) TraceID() string

v0.16.0

Feb 13, 2026

Changes in this version

type HealthOption

+ func WithLivezPath(path string) HealthOption

v0.15.0

Feb 12, 2026

v0.14.1

Feb 11, 2026

v0.14.0

Feb 10, 2026

Changes in this version

type App

+ func (a *App) OnReload(fn func(context.Context) error)

+ func (a *App) Reload(ctx context.Context) error

v0.13.0

Feb 7, 2026

v0.12.0

Feb 7, 2026

v0.11.1

Feb 5, 2026

v0.11.0

Feb 5, 2026

Changes in this version

type Context

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

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

+ func (c *Context) FailStatus(status int, err error)

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

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

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

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

v0.10.0

Feb 4, 2026

v0.9.0

Feb 4, 2026

Changes in this version

+ func BindOnly[T any](c *Context, opts ...BindOption) (T, error)

+ func BindPatch[T any](c *Context, opts ...BindOption) (T, error)

+ func BindStrict[T any](c *Context, opts ...BindOption) (T, error)

+ func Bind[T any](c *Context, opts ...BindOption) (T, error)

+ func MustBindPatch[T any](c *Context, opts ...BindOption) (T, bool)

+ func MustBindStrict[T any](c *Context, opts ...BindOption) (T, bool)

+ func MustBind[T any](c *Context, opts ...BindOption) (T, bool)

+ type BindOption func(*bindConfig)

+ func WithBindingOptions(opts ...binding.Option) BindOption

+ func WithPartial() BindOption

+ func WithPresence(pm validation.PresenceMap) BindOption

+ func WithStrict() BindOption

+ func WithValidationOptions(opts ...validation.Option) BindOption

+ func WithoutValidation() BindOption

type Context

+ func TestContextWithBody(method, path string, body any) (*Context, error)

+ func TestContextWithForm(method, path string, values map[string][]string) (*Context, error)

+ func (c *Context) BindOnly(out any, opts ...BindOption) error

+ func (c *Context) MustBind(out any, opts ...BindOption) bool

+ func (c *Context) Validate(v any, opts ...validation.Option) error

v0.8.1

Feb 3, 2026

v0.8.0

Feb 3, 2026

v0.7.0

Feb 2, 2026

v0.6.0

Feb 1, 2026

Changes in this version

+ const DefaultPort

+ const EnvHost

+ const EnvLogFormat

+ const EnvLogLevel

+ const EnvMetricsAddr

+ const EnvMetricsEndpoint

+ const EnvMetricsExporter

+ const EnvMetricsPath

+ const EnvMode

+ const EnvPort

+ const EnvPprofEnabled

+ const EnvPrefix

+ const EnvReadTimeout

+ const EnvServiceName

+ const EnvServiceVersion

+ const EnvShutdownTimeout

+ const EnvTracingEndpoint

+ const EnvTracingExporter

+ const EnvWriteTimeout

type Option

+ func WithEnv() Option

+ func WithEnvPrefix(prefix string) Option

+ func WithHost(host string) Option

+ func WithPort(port int) Option

v0.5.1

Jan 30, 2026

v0.5.0

Jan 27, 2026

Changes in this version

+ type LoggingConfig struct

+ Handler LoggingHandler

+ Level LoggingLevel

+ type LoggingHandler string

+ const LoggingConsole

+ const LoggingJSON

+ type LoggingLevel string

+ const LoggingDebug

+ const LoggingError

+ const LoggingInfo

+ const LoggingWarn

+ type MetricsConfig struct

+ Endpoint string

+ Path string

+ Provider MetricsProvider

+ type MetricsProvider string

+ const MetricsOTLP

+ const MetricsPrometheus

+ const MetricsStdout

+ type ObservabilityConfig struct

+ ExcludePaths []string

+ ExcludePrefixes []string

+ Logging LoggingConfig

+ Metrics MetricsConfig

+ Tracing TracingConfig

type Option

+ func WithObservabilityFromConfig(cfg ObservabilityConfig) Option

+ func WithRouter(opts ...router.Option) Option

+ func WithServer(opts ...ServerOption) Option

+ type TracingConfig struct

+ Endpoint string

+ Insecure bool

+ Provider TracingProvider

+ SampleRate float64

+ type TracingProvider string

+ const TracingNoop

+ const TracingOTLP

+ const TracingOTLPHTTP

+ const TracingStdout

v0.4.0

Dec 18, 2025

Changes in this version

+ type RouteOption func(*routeConfig)

+ func RouteOptions(opts ...RouteOption) RouteOption

+ func WithAfter(handlers ...HandlerFunc) RouteOption

+ func WithBefore(handlers ...HandlerFunc) RouteOption

+ func WithDoc(opts ...openapi.OperationOption) RouteOption

+ func WithoutDoc() RouteOption

v0.3.0

Dec 9, 2025

Changes in this version

type App

+ func (a *App) Start(ctx context.Context, addr string) error

+ func (a *App) StartMTLS(ctx context.Context, addr string, serverCert tls.Certificate, ...) error

+ func (a *App) StartTLS(ctx context.Context, addr, certFile, keyFile string) error

v0.2.0

Dec 5, 2025

Changes in this version

+ type DebugOption func(*debugSettings)

+ func WithDebugPrefix(prefix string) DebugOption

+ func WithPprof() DebugOption

+ func WithPprofIf(condition bool) DebugOption

+ type HealthOption func(*healthSettings)

+ func WithHealthPrefix(prefix string) HealthOption

+ func WithHealthTimeout(d time.Duration) HealthOption

+ func WithHealthzPath(path string) HealthOption

+ func WithLivenessCheck(name string, check CheckFunc) HealthOption

+ func WithReadinessCheck(name string, check CheckFunc) HealthOption

+ func WithReadyzPath(path string) HealthOption

+ type ObservabilityOption func(*observabilitySettings)

+ func WithAccessLogging(enabled bool) ObservabilityOption

+ func WithExcludePaths(paths ...string) ObservabilityOption

+ func WithExcludePatterns(patterns ...string) ObservabilityOption

+ func WithExcludePrefixes(prefixes ...string) ObservabilityOption

+ func WithLogOnlyErrors() ObservabilityOption

+ func WithLogging(opts ...logging.Option) ObservabilityOption

+ func WithMetricsOnMainRouter(path string) ObservabilityOption

+ func WithMetricsSeparateServer(addr, path string) ObservabilityOption

+ func WithSlowThreshold(d time.Duration) ObservabilityOption

+ func WithoutDefaultExclusions() ObservabilityOption

type Option

+ func WithDebugEndpoints(opts ...DebugOption) Option

+ func WithHealthEndpoints(opts ...HealthOption) Option

+ func WithObservability(opts ...ObservabilityOption) Option

+ func WithoutDefaultMiddleware() Option

v0.1.0

Nov 24, 2025

Changes in this version

+ const DefaultEnvironment

+ const DefaultIdleTimeout

+ const DefaultMaxHeaderBytes

+ const DefaultReadHeaderTimeout

+ const DefaultReadTimeout

+ const DefaultServiceName

+ const DefaultShutdownTimeout

+ const DefaultVersion

+ const DefaultWriteTimeout

+ const EnvironmentDevelopment

+ const EnvironmentProduction

+ func BindAndValidateInto[T any](c *Context, opts ...validation.Option) (T, error)

+ func ExpectJSON(t testingT, resp *http.Response, statusCode int, out any)

+ func GetMTLSCertificate(req *http.Request) *x509.Certificate

+ func MustBindAndValidateInto[T any](c *Context, opts ...validation.Option) (T, bool)

+ type App struct

+ func MustNew(opts ...Option) *App

+ func New(opts ...Option) (*App, error)

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

+ func (a *App) BaseLogger() *slog.Logger

+ func (a *App) DELETE(path string, handler HandlerFunc) *RouteWrapper

+ func (a *App) Environment() string

+ func (a *App) File(path, filepath string)

+ func (a *App) GET(path string, handler HandlerFunc) *RouteWrapper

+ func (a *App) GetMetricsHandler() (http.Handler, error)

+ func (a *App) GetMetricsServerAddress() string

+ func (a *App) Group(prefix string, middleware ...HandlerFunc) *Group

+ func (a *App) HEAD(path string, handler HandlerFunc) *RouteWrapper

+ func (a *App) HasMetrics() bool

+ func (a *App) Logging() *slog.Logger

+ func (a *App) Metrics() *metrics.Config

+ func (a *App) MustURLFor(routeName string, params map[string]string, query map[string][]string) string

+ func (a *App) NoRoute(handler HandlerFunc)

+ func (a *App) OPTIONS(path string, handler HandlerFunc) *RouteWrapper

+ func (a *App) OnReady(fn func())

+ func (a *App) OnRoute(fn func(router.Route))

+ func (a *App) OnShutdown(fn func(context.Context))

+ func (a *App) OnStart(fn func(context.Context) error)

+ func (a *App) OnStop(fn func())

+ func (a *App) PATCH(path string, handler HandlerFunc) *RouteWrapper

+ func (a *App) POST(path string, handler HandlerFunc) *RouteWrapper

+ func (a *App) PUT(path string, handler HandlerFunc) *RouteWrapper

+ func (a *App) PrintRoutes()

+ func (a *App) Readiness() *ReadinessManager

+ func (a *App) Route(name string) (router.Route, bool)

+ func (a *App) Router() *router.Router

+ func (a *App) Routes() []router.Route

+ func (a *App) Run(addr string) error

+ func (a *App) RunMTLS(addr string, serverCert tls.Certificate, opts ...MTLSOption) error

+ func (a *App) RunTLS(addr, certFile, keyFile string) error

+ func (a *App) ServiceName() string

+ func (a *App) ServiceVersion() string

+ func (a *App) Static(prefix, root string)

+ func (a *App) StaticFS(prefix string, fs http.FileSystem)

+ func (a *App) Test(req *http.Request, opts ...TestOption) (*http.Response, error)

+ func (a *App) TestJSON(method, path string, body any, opts ...TestOption) (*http.Response, error)

+ func (a *App) Tracing() *tracing.Config

+ func (a *App) URLFor(routeName string, params map[string]string, query map[string][]string) (string, error)

+ func (a *App) Use(middleware ...HandlerFunc)

+ func (a *App) Version(version string) *VersionGroup

+ func (a *App) WithDebugEndpoints(o DebugEndpointsOpts) error

+ func (a *App) WithMetricsEndpoint(o MetricsEndpointOpts) error

+ func (a *App) WithStandardEndpoints(o StandardEndpointsOpts) error

+ func (a *App) WrapHandler(handler HandlerFunc) router.HandlerFunc

+ type CheckFunc func(ctx context.Context) error

+ type ConfigError struct

+ Constraint string

+ Field string

+ Message string

+ Value any

+ func (e *ConfigError) Error() string

+ func (e *ConfigError) Unwrap() error

+ type Context struct

+ func (c *Context) BadRequest(message string)

+ func (c *Context) Bind(out any) error

+ func (c *Context) BindAndValidate(out any, opts ...validation.Option) error

+ func (c *Context) BindAndValidateStrict(out any, opts ...validation.Option) error

+ func (c *Context) BindJSONStrict(out any) error

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

+ func (c *Context) ErrorStatus(err error, status int)

+ func (c *Context) Forbidden(message string)

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

+ func (c *Context) Logger() *slog.Logger

+ func (c *Context) MustBindAndValidate(out any, opts ...validation.Option) bool

+ func (c *Context) NotFound(message string)

+ func (c *Context) Presence() validation.PresenceMap

+ func (c *Context) ResetBinding()

+ func (c *Context) Unauthorized(message string)

+ type DebugEndpointsOpts struct

+ EnablePprof bool

+ MountPrefix string

+ type Gate interface

+ Name func() string

+ Ready func() bool

+ type Group struct

+ func (g *Group) Any(path string, handler HandlerFunc)

+ func (g *Group) DELETE(path string, handler HandlerFunc) *RouteWrapper

+ func (g *Group) GET(path string, handler HandlerFunc) *RouteWrapper

+ func (g *Group) Group(prefix string, middleware ...HandlerFunc) *Group

+ func (g *Group) HEAD(path string, handler HandlerFunc) *RouteWrapper

+ func (g *Group) OPTIONS(path string, handler HandlerFunc) *RouteWrapper

+ func (g *Group) PATCH(path string, handler HandlerFunc) *RouteWrapper

+ func (g *Group) POST(path string, handler HandlerFunc) *RouteWrapper

+ func (g *Group) PUT(path string, handler HandlerFunc) *RouteWrapper

+ func (g *Group) Use(middleware ...HandlerFunc)

+ type HandlerFunc func(*Context)

+ type Hooks struct

+ type MTLSOption func(*mtlsConfig)

+ func WithAuthorize(fn func(*x509.Certificate) (principal string, allowed bool)) MTLSOption

+ func WithClientCAs(pool *x509.CertPool) MTLSOption

+ func WithConfigForClient(fn func(*tls.ClientHelloInfo) (*tls.Config, error)) MTLSOption

+ func WithMinVersion(version uint16) MTLSOption

+ func WithSNI(fn func(*tls.ClientHelloInfo) (*tls.Certificate, error)) MTLSOption

+ type MetricsEndpointOpts struct

+ Enabled bool

+ MountPath string

+ type Option func(*config)

+ func WithDefaultErrorFormat(mediaType string) Option

+ func WithEnvironment(env string) Option

+ func WithErrorFormatter(formatter errors.Formatter) Option

+ func WithErrorFormatters(formatters map[string]errors.Formatter) Option

+ func WithErrorLogger(logger *slog.Logger) Option

+ func WithLogger(logger *slog.Logger) Option

+ func WithMetrics(opts ...metrics.Option) Option

+ func WithMiddleware(middlewares ...HandlerFunc) Option

+ func WithOpenAPI(opts ...openapi.Option) Option

+ func WithRouterOptions(opts ...router.Option) Option

+ func WithServerConfig(opts ...ServerOption) Option

+ func WithServiceName(name string) Option

+ func WithServiceVersion(version string) Option

+ func WithTracing(opts ...tracing.Option) Option

+ type ReadinessManager struct

+ func (rm *ReadinessManager) Check() (bool, map[string]bool)

+ func (rm *ReadinessManager) Register(name string, gate Gate)

+ func (rm *ReadinessManager) Unregister(name string)

+ type RouteWrapper struct

+ func (rw *RouteWrapper) Deprecated() *RouteWrapper

+ func (rw *RouteWrapper) Description(description string) *RouteWrapper

+ func (rw *RouteWrapper) Doc(summary, description string) *RouteWrapper

+ func (rw *RouteWrapper) OpenAPI() *openapi.RouteWrapper

+ func (rw *RouteWrapper) Request(example any) *RouteWrapper

+ func (rw *RouteWrapper) Response(status int, example any) *RouteWrapper

+ func (rw *RouteWrapper) Route() *router.Route

+ func (rw *RouteWrapper) Security(scheme string, scopes ...string) *RouteWrapper

+ func (rw *RouteWrapper) Summary(summary string) *RouteWrapper

+ func (rw *RouteWrapper) Tag(tags ...string) *RouteWrapper

+ func (rw *RouteWrapper) Tags(tags ...string) *RouteWrapper

+ func (rw *RouteWrapper) Where(param, pattern string) *RouteWrapper

+ func (rw *RouteWrapper) WhereAlpha(param string) *RouteWrapper

+ func (rw *RouteWrapper) WhereAlphaNumeric(param string) *RouteWrapper

+ func (rw *RouteWrapper) WhereDate(name string) *RouteWrapper

+ func (rw *RouteWrapper) WhereDateTime(name string) *RouteWrapper

+ func (rw *RouteWrapper) WhereEnum(name string, values ...string) *RouteWrapper

+ func (rw *RouteWrapper) WhereFloat(name string) *RouteWrapper

+ func (rw *RouteWrapper) WhereInt(name string) *RouteWrapper

+ func (rw *RouteWrapper) WhereNumber(param string) *RouteWrapper

+ func (rw *RouteWrapper) WhereRegex(name, pattern string) *RouteWrapper

+ func (rw *RouteWrapper) WhereUUID(name string) *RouteWrapper

+ type ServerOption func(*serverConfig)

+ func WithIdleTimeout(d time.Duration) ServerOption

+ func WithMaxHeaderBytes(n int) ServerOption

+ func WithReadHeaderTimeout(d time.Duration) ServerOption

+ func WithReadTimeout(d time.Duration) ServerOption

+ func WithShutdownTimeout(d time.Duration) ServerOption

+ func WithWriteTimeout(d time.Duration) ServerOption

+ type StandardEndpointsOpts struct

+ Liveness map[string]CheckFunc

+ MountPrefix string

+ Readiness map[string]CheckFunc

+ Timeout time.Duration

+ type TestOption func(*testConfig)

+ func WithContext(ctx context.Context) TestOption

+ func WithTimeout(d time.Duration) TestOption

+ type ValidationError struct

+ Errors []*ConfigError

+ func (ve *ValidationError) Add(err *ConfigError)

+ func (ve *ValidationError) Error() string

+ func (ve *ValidationError) HasErrors() bool

+ func (ve *ValidationError) ToError() error

+ type VersionGroup struct

+ func (vg *VersionGroup) Any(path string, handler HandlerFunc)

+ func (vg *VersionGroup) DELETE(path string, handler HandlerFunc) *RouteWrapper

+ func (vg *VersionGroup) GET(path string, handler HandlerFunc) *RouteWrapper

+ func (vg *VersionGroup) Group(prefix string, middleware ...HandlerFunc) *router.VersionGroup

+ func (vg *VersionGroup) HEAD(path string, handler HandlerFunc) *RouteWrapper

+ func (vg *VersionGroup) OPTIONS(path string, handler HandlerFunc) *RouteWrapper

+ func (vg *VersionGroup) PATCH(path string, handler HandlerFunc) *RouteWrapper

+ func (vg *VersionGroup) POST(path string, handler HandlerFunc) *RouteWrapper

+ func (vg *VersionGroup) PUT(path string, handler HandlerFunc) *RouteWrapper

+ func (vg *VersionGroup) Use(middleware ...HandlerFunc)

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