Skip to main content

capy_framework/
lib.rs

1//! An opinionated full-stack Rust web framework with strong conventions and sensible defaults.
2//!
3//! Capy integrates routing, validation, configuration, and database tooling with
4//! a predictable application structure.
5//!
6//! Depend on this package as `capy = { package = "capy-framework", version = "0.4.0" }`.
7//! The prelude contains the common API; named re-exports retain native escape hatches.
8
9mod app;
10mod diagnostics;
11mod frontend;
12mod http_policy;
13mod readiness;
14
15pub use diagnostics::{RequestObservation, RequestObserver};
16pub use readiness::ready;
17
18pub use app::App;
19pub use capy_core::{
20    AppConfig, AppContext, AppError, AppSettings, Context, DatabaseSettings, HttpSettings, Result,
21    ServerSettings, ValidationErrors,
22};
23pub use capy_db as db;
24pub use capy_http::{
25    health, Created, Json, NoContent, Page, PageMeta, Pagination, Path, Query, RouteInfo, Routes,
26};
27pub use capy_validation::Validated;
28
29pub use axum;
30pub use chrono;
31pub use sea_orm;
32pub use sea_orm_migration as migration;
33pub use serde;
34pub use serde_json;
35pub use tokio;
36pub use tower;
37pub use tower_http;
38pub use tracing;
39pub use validator;
40
41#[cfg(feature = "testing")]
42pub use capy_testing as testing;
43
44/// The small set of types most API handlers need.
45pub mod prelude {
46    pub use crate::{
47        App, AppConfig, AppContext, AppError, Context, Created, Json, NoContent, Page, Pagination,
48        Path, Query, Result, Routes, Validated,
49    };
50    pub use sea_orm::DatabaseConnection;
51    pub use serde::{Deserialize, Serialize};
52    pub use serde_json::{json, Value};
53    pub use validator::Validate;
54}
55
56mod dev_logging;