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.2.0" }`.
7//! The prelude contains the common API; named re-exports retain native escape hatches.
8
9mod app;
10mod diagnostics;
11mod frontend;
12
13pub use app::App;
14pub use capy_core::{
15    AppConfig, AppContext, AppError, AppSettings, Context, DatabaseSettings, Result,
16    ValidationErrors,
17};
18pub use capy_db as db;
19pub use capy_http::{health, Created, Json, NoContent, RouteInfo, Routes};
20pub use capy_validation::Validated;
21
22pub use axum;
23pub use chrono;
24pub use sea_orm;
25pub use sea_orm_migration as migration;
26pub use serde;
27pub use serde_json;
28pub use tokio;
29pub use tower;
30pub use tower_http;
31pub use tracing;
32pub use validator;
33
34#[cfg(feature = "testing")]
35pub use capy_testing as testing;
36
37/// The small set of types most API handlers need.
38pub mod prelude {
39    pub use crate::{
40        App, AppConfig, AppContext, AppError, Context, Created, Json, NoContent, Result, Routes,
41        Validated,
42    };
43    pub use axum::extract::{Path, Query};
44    pub use sea_orm::DatabaseConnection;
45    pub use serde::{Deserialize, Serialize};
46    pub use serde_json::{json, Value};
47    pub use validator::Validate;
48}