Documentation
¶
Index ¶
- type Option
- func WithAPIKeyVerifier(verifier middlewares.APIKeyVerifier) Option
- func WithCSRFConfig(config middleware.CSRFConfig) Option
- func WithInstallationStateReader(reader middlewares.InstallationStateReader) Option
- func WithLoginSessionAuthenticator(authenticator middlewares.LoginSessionAuthenticator) Option
- func WithLoginSessionCookieName(name string) Option
- func WithPreInitRoutes(routes ...middlewares.RouteExemption) Option
- func WithStatusReporter(reporter StatusReporter) Option
- func WithSystemErrorRecorder(recorder middlewares.SystemErrorRecorder) Option
- func WithUnauthenticatedRoutes(routes ...middlewares.RouteExemption) Option
- type Server
- type StatusReporter
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Option ¶
type Option func(*Server)
Option customizes the HTTP server.
func WithAPIKeyVerifier ¶
func WithAPIKeyVerifier(verifier middlewares.APIKeyVerifier) Option
WithAPIKeyVerifier installs optional API token authentication.
func WithCSRFConfig ¶
func WithCSRFConfig(config middleware.CSRFConfig) Option
WithCSRFConfig installs the auth-owned Echo CSRF configuration. CSRF activation still derives from login sessions: without an injected config the CSRF middleware is not installed.
func WithInstallationStateReader ¶
func WithInstallationStateReader(reader middlewares.InstallationStateReader) Option
WithInstallationStateReader installs the uninitialized-system gate.
func WithLoginSessionAuthenticator ¶
func WithLoginSessionAuthenticator(authenticator middlewares.LoginSessionAuthenticator) Option
WithLoginSessionAuthenticator installs browser login-session authentication.
func WithLoginSessionCookieName ¶
WithLoginSessionCookieName installs the login-session cookie name. The name is Login Session domain policy declared by the auth module; the composition root injects it so the read and write sides share one declaration.
func WithPreInitRoutes ¶
func WithPreInitRoutes(routes ...middlewares.RouteExemption) Option
WithPreInitRoutes installs routes that stay reachable before first initialization completes. The composition root derives them from its route exposure declaration.
func WithStatusReporter ¶
func WithStatusReporter(reporter StatusReporter) Option
WithStatusReporter installs the readiness and capability reporter.
func WithSystemErrorRecorder ¶
func WithSystemErrorRecorder(recorder middlewares.SystemErrorRecorder) Option
WithSystemErrorRecorder installs optional internal-error recording.
func WithUnauthenticatedRoutes ¶
func WithUnauthenticatedRoutes(routes ...middlewares.RouteExemption) Option
WithUnauthenticatedRoutes installs routes reachable without a login session; CSRF exemptions derive from the same list. The composition root derives them from its route exposure declaration.
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server owns the Echo HTTP server lifecycle and system routes.
func New ¶
New creates an Echo-backed HTTP server. cfg must come from configs.Load, which owns normalization and validation; New trusts its input.
type StatusReporter ¶
type StatusReporter interface {
Status(context.Context) []resources.CapabilityStatus
Ready(context.Context) error
}
StatusReporter supplies readiness and capability status to system routes. The status record shape is owned by the infrastructure resources package, which also builds the only three legal states.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package httpreq parses and validates Echo request inputs for HTTP adapters.
|
Package httpreq parses and validates Echo request inputs for HTTP adapters. |
|
Package httpresp renders framework-specific HTTP error responses.
|
Package httpresp renders framework-specific HTTP error responses. |
|
Package middlewares contains server-owned Echo middleware adapters.
|
Package middlewares contains server-owned Echo middleware adapters. |