Skip to main content

wordval_web/
lib.rs

1//! # wordval-web
2//!
3//! Wordval Web 层:路由、中间件、提取器、响应、会话认证、多租户。
4//!
5//! ## 主要模块
6//!
7//! - [`app`] — 应用构建器 `App`
8//! - [`router`] — 路由注册与分发
9//! - [`middleware`] — 认证、权限、会话等中间件
10//! - `idempotency` — `#[idempotent]` 宏运行时支撑(需启用 `cache` feature)
11//! - [`extract`] — 请求提取器(当前用户、租户、文件等)
12//! - [`resources`] — 全局资源管理(配置、数据库、缓存)
13//! - [`tenant`] — 多租户支持
14//!
15//! ## 快速开始
16//!
17//! ```ignore
18//! use wordval_web::{App, WordvalRouter};
19//!
20//! let app = App::new()
21//!     .route("GET", "/api/hello", || "Hello, World!");
22//! ```
23
24pub mod app;
25pub mod audit;
26pub mod chain;
27pub mod extract;
28#[cfg(feature = "cache")]
29pub mod idempotency;
30pub mod middleware;
31pub mod policy;
32pub mod resources;
33pub mod router;
34pub mod sse;
35pub mod tenant;
36
37#[cfg(feature = "template")]
38pub mod template_engine;
39
40pub use app::App;
41pub use audit::{AuditConfig, AuditRecord, AuditResult, AuditSink, AuditWriter};
42pub use extract::{
43    ClientContext, CurrentUser, FileSender, OptionalUser, RequestedTenantId, TenantId,
44    ValidatedJson,
45};
46pub use middleware::{AuthLayer, RequireRoleLayer, RequestStart};
47pub use tenant::{
48    current_tenant_id, require_tenant_id, resolve_tenant, tenant_context_layer, with_tenant,
49};
50// 统一响应类型定义在 wordval-core(框架公共"语言"),此处仅转发保持既有路径
51pub use router::{RouteEntry, RouteGuard, WordvalRouter};
52pub use wordval_core::api::{ApiError, PageData, Res, ResResult};
53
54#[cfg(feature = "cache")]
55pub use crate::resources::{cache, set_cache, try_cache};
56pub use crate::resources::{cfg, config, set_config, try_config};
57pub use crate::resources::{
58    audit_write, audit_writer, set_audit_writer, shutdown_audit_writer, try_audit_writer,
59};
60#[cfg(feature = "db")]
61pub use crate::resources::{
62    db, db_default, db_names, register_db, remove_db, set_db, set_dbs, try_db, try_using, DbHandle,
63    DEFAULT_DB_NAME,
64};
65pub use crate::resources::{
66    download_path, set_download_path, set_upload_path, try_download_path, try_upload_path,
67    upload_path,
68};
69#[cfg(feature = "template")]
70pub use crate::resources::{render_template, set_template, try_template};
71#[cfg(feature = "template")]
72pub use crate::template_engine::TemplateEngine;
73
74/// 路由注册分布式切片——`#[get]`、`#[post]` 等宏注解的处理器在此汇集
75///
76/// 宏注解把路由与守卫策略(权限 / 免认证 / 审计)一并注册到 [`WordvalRouter`],
77/// 启动时 `App` 从路由元数据派生中间件规则,不再需要单独的规则切片。
78#[linkme::distributed_slice]
79pub static ROUTES: [fn(&mut WordvalRouter)] = [..];