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