footing 0.1.9

Feature-gated foundations for Rust backend services
Documentation
//! HTTP helpers for Axum services.
//!
//! This module contains reusable HTTP infrastructure: request context
//! propagation, RFC 9457 problem responses, validation extractors, pagination
//! extractors, CORS/security layers, route-aware runtime policy, and principal
//! extraction.
//!
//! ```rust
//! use axum::http::StatusCode;
//! use footing::http::{ApiProblem, ProblemCode};
//!
//! let problem = ApiProblem::bad_request(
//!     ProblemCode::try_new("invalid_query").unwrap(),
//!     "query is invalid",
//! );
//! assert_eq!(problem.status(), StatusCode::BAD_REQUEST);
//! ```
//!
/// Authentication hooks and principal extractors.
pub mod auth;
/// Endpoint contracts and route reconciliation.
pub mod contract;
/// RFC 9457 problem responses and API error boundaries.
pub mod error;
/// Public health-response projection.
pub mod health;
pub mod idempotency;
pub mod layers;
/// Bounded-cardinality HTTP metrics middleware and responses.
pub mod metrics;
/// Request-context middleware entry points.
pub mod middleware;
#[cfg(feature = "openapi")]
#[cfg_attr(docsrs, doc(cfg(feature = "openapi")))]
pub mod openapi;
/// Offset pagination extractors.
pub mod pagination;
/// Query deserialization helpers.
pub mod query;
pub mod rate_limit;
pub mod request_context;
/// Forwarded-header trust policy.
pub mod trusted_proxy;
/// Validated JSON extraction and field violations.
pub mod validation;

pub use crate::net::{ClientIp, ClientIpError, MAX_CLIENT_IP_LENGTH};
pub use auth::{
    CurrentPrincipal, HttpAuthenticationHook, OptionalPrincipal, VerifiedAuthentication,
};
pub use contract::{
    EndpointAudit, EndpointAuth, EndpointContract, EndpointContractDocument,
    EndpointContractReconciliationError, EndpointContractRegistry, EndpointContractSnapshot,
    EndpointContractSnapshotSummary, EndpointContractValidationError, EndpointIdempotency,
    EndpointMethod, EndpointMethodError, EndpointPagination, EndpointPathPattern,
    EndpointPermissions, EndpointPermissionsDocument, EndpointRateLimit, EndpointRisk,
    EndpointRouteRegistration, ReconciledEndpointContracts,
};
pub use error::{
    ApiErrorBoundary, ApiProblem, ApiProblemStatusError, DEFAULT_PROBLEM_CODE, ErrorCategory,
    IntoApiProblem, MAX_PROBLEM_CODE_LENGTH, MAX_PROBLEM_TYPE_LENGTH, ProblemCode, ProblemDetails,
    ProblemIdentifierError, ProblemType, PublicError,
};
pub use health::HealthResponse;
pub use idempotency::{
    DEFAULT_IDEMPOTENCY_MAX_BODY_BYTES, DEFAULT_IDEMPOTENCY_PROCESSING_TTL,
    DEFAULT_IDEMPOTENCY_TTL, DEFAULT_MAX_IDEMPOTENCY_RECORDS,
    DEFAULT_MAX_IDEMPOTENCY_STORED_HEADER_BYTES, DEFAULT_MAX_IDEMPOTENCY_STORED_RESPONSE_BYTES,
    IDEMPOTENCY_KEY_HEADER_NAME, IDEMPOTENCY_REPLAYED_HEADER_NAME, IdempotencyConfig,
    IdempotencyConfigError, IdempotencyHeaderError, IdempotencyKey, IdempotencyKeyError,
    IdempotencyLayer, IdempotencyLease, IdempotencyRejection, IdempotencyRequestHash,
    IdempotencyRequestPolicy, IdempotencyReservation, IdempotencyRuntime, IdempotencyScope,
    IdempotencyService, IdempotencyState, IdempotencyStore, IdempotencyStoreError,
    MAX_IDEMPOTENCY_KEY_LENGTH, MemoryIdempotencyStore, RequiredIdempotencyKey,
    StoredIdempotencyResponse, idempotency_key_from_headers, idempotency_middleware,
    is_valid_idempotency_key, parse_required_idempotency_key, run_idempotent_request,
    run_idempotent_service,
};
pub use layers::{
    CorsConfig, CorsPolicy, DEFAULT_HSTS_MAX_AGE, DEFAULT_HTTP_REQUEST_BODY_LIMIT,
    DEFAULT_HTTP_TIMEOUT, EffectiveHttpRequestPolicy, HttpMiddlewareConfig, HttpMiddlewareError,
    HttpMiddlewareStack, HttpMiddlewareStackBuilder, HttpRateLimitConfig, HttpRequestPolicy,
    HttpRouteRule, RequestBodyLimitPolicy, RouteMatcher, SecurityHeadersConfig,
};
#[cfg(feature = "settings")]
pub use layers::{
    CorsMode, CorsSettings, ForwardedHeadersMode, ForwardedHeadersSettings,
    HttpIdempotencySettings, HttpMiddlewareSettings, HttpRateLimitSettings,
    HttpRequestPolicySettings, HttpRouteRuleSettings, IdempotencyRequestPolicySettings,
    RateLimitKeySourceSettings, RateLimitRequestPolicySettings, RequestBodyLimitSettings,
    RouteMatcherSettings, SecurityHeadersSettings, StrictTransportSecuritySettings,
};
pub use metrics::{
    HTTP_METRICS_UNMATCHED_ROUTE, HttpMetricRouteLabel, HttpMetricsLayer, HttpMetricsService,
    MetricsResponse, OPENMETRICS_CONTENT_TYPE, record_http_metrics,
};
pub use middleware::{
    request_context_middleware, request_context_middleware_with_forwarded_policy,
};
pub use pagination::{
    CursorPagination, CursorPaginationQuery, OffsetPagination, OffsetPaginationQuery,
};
// Preserve the original public import paths during the naming transition.
#[cfg(feature = "settings")]
pub use layers::HttpFoundationSettings;
pub use layers::{HttpFoundation, HttpFoundationBuilder, HttpLayerConfig, HttpLayerError};
pub use pagination::{Pagination, PaginationQuery};
pub use query::{QueryParams, deserialize_bool_from_query, deserialize_optional_u32_from_query};
pub use rate_limit::{
    DEFAULT_MAX_RATE_LIMIT_BUCKETS, MAX_RATE_LIMIT_HEADER_VALUE_BYTES, MemoryRateLimitStore,
    RateLimitConfig, RateLimitDecision, RateLimitError, RateLimitKeySource, RateLimitLayer,
    RateLimitRejection, RateLimitRequestPolicy, RateLimitRuntime, RateLimitService, RateLimitStore,
    TokenBucketRateLimiter, TrustedRateLimitHeader, enforce_rate_limit, rate_limit_middleware,
};
pub use request_context::{
    CLIENT_ID_HEADER_NAME, ClientIpSource, LOCALE_HEADER_NAME, MAX_REQUEST_CONTEXT_VALUE_LENGTH,
    MAX_REQUEST_ID_LENGTH, MAX_USER_AGENT_LENGTH, REQUEST_ID_HEADER_NAME, RequestContext,
    RequestId, RequestIdError, SESSION_ID_HEADER_NAME, TIME_ZONE_HEADER_NAME,
    TRACEPARENT_HEADER_NAME, TRACEPARENT_LENGTH, TraceParent, TraceParentError,
    UTC_OFFSET_HEADER_NAME, is_valid_request_id, is_valid_traceparent,
};
pub use trusted_proxy::{ForwardedHeadersPolicy, TrustedProxyConfig};
pub use validation::{FieldViolation, FieldViolations, Validate, ValidatedJson, ValidationError};