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;
10#[cfg(feature = "mail")]
11pub use capy_mail as mail;
12#[cfg(feature = "mail")]
13pub use capy_mail::notifications;
14#[cfg(feature = "jobs")]
15mod job_commands;
16#[cfg(feature = "jobs")]
17pub use capy_jobs as jobs;
18mod diagnostics;
19mod frontend;
20mod http_policy;
21mod readiness;
22
23pub use diagnostics::{RequestObservation, RequestObserver};
24pub use readiness::{ready, ReadinessResponse};
25
26pub use app::App;
27#[cfg(feature = "auth")]
28pub use capy_auth as auth;
29pub use capy_core::{
30    ApiErrorResponse, ApiSettings, AppConfig, AppContext, AppError, AppSettings, AuthSettings,
31    Context, DatabaseSettings, HttpSettings, JobsSettings, MailSettings, Result, SameSite,
32    ServerSettings, SmtpSettings, ValidationErrors,
33};
34pub use capy_db as db;
35pub use capy_http::{
36    health, schema, ApiDocument, ApiRouteInfo, ApiSchema, Created, HealthResponse, Json, NoContent,
37    Page, PageMeta, Paginated, Pagination, PaginationMeta, Path, Query, RouteInfo, Routes,
38};
39pub use capy_validation::Validated;
40
41pub use axum;
42pub use chrono;
43pub use sea_orm;
44pub use sea_orm_migration as migration;
45pub use serde;
46pub use serde_json;
47pub use tokio;
48pub use tower;
49pub use tower_http;
50pub use tracing;
51pub use validator;
52
53#[cfg(feature = "testing")]
54pub use capy_testing as testing;
55
56/// The small set of types most API handlers need.
57pub mod prelude {
58    pub use crate::{
59        ApiSchema, App, AppConfig, AppContext, AppError, Context, Created, Json, NoContent, Page,
60        Paginated, Pagination, Path, Query, Result, Routes, Validated,
61    };
62    #[cfg(feature = "jobs")]
63    pub use capy_jobs::JobDispatch;
64    #[cfg(feature = "mail")]
65    pub use capy_mail::{MailContext, Mailable};
66    pub use sea_orm::DatabaseConnection;
67    pub use serde::{Deserialize, Serialize};
68    pub use serde_json::{json, Value};
69    pub use validator::Validate;
70}
71
72mod dev_logging;