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.5.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, ReadinessResponse};
17
18pub use app::App;
19pub use capy_core::{
20    ApiErrorResponse, ApiSettings, AppConfig, AppContext, AppError, AppSettings, Context,
21    DatabaseSettings, HttpSettings, Result, ServerSettings, ValidationErrors,
22};
23pub use capy_db as db;
24pub use capy_http::{
25    health, schema, ApiDocument, ApiRouteInfo, ApiSchema, Created, HealthResponse, Json, NoContent,
26    Page, PageMeta, Paginated, Pagination, PaginationMeta, Path, Query, RouteInfo, Routes,
27};
28pub use capy_validation::Validated;
29
30pub use axum;
31pub use chrono;
32pub use sea_orm;
33pub use sea_orm_migration as migration;
34pub use serde;
35pub use serde_json;
36pub use tokio;
37pub use tower;
38pub use tower_http;
39pub use tracing;
40pub use validator;
41
42#[cfg(feature = "testing")]
43pub use capy_testing as testing;
44
45/// The small set of types most API handlers need.
46pub mod prelude {
47    pub use crate::{
48        ApiSchema, App, AppConfig, AppContext, AppError, Context, Created, Json, NoContent, Page,
49        Paginated, Pagination, Path, Query, Result, Routes, Validated,
50    };
51    pub use sea_orm::DatabaseConnection;
52    pub use serde::{Deserialize, Serialize};
53    pub use serde_json::{json, Value};
54    pub use validator::Validate;
55}
56
57mod dev_logging;