axa 0.2.0

Small shared library for services built directly on Axum.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

//! # axa
//!
//! Small shared library for services built directly on Axum.
//!
//! This is a library, not a framework. A service's `main.rs` stays ordinary
//! Axum and calls into this crate: there are no lifecycle hooks or macros, and
//! [`AppContext`] is a plain struct passed as ordinary Axum state. Every piece
//! can be read, replaced, or left out on its own.
//!
//! # Example
//!
//! Declare routes, turn them into a plain [`axum::Router`] under the standard
//! middleware, and serve it:
//!
//! ```
//! use axa::prelude::*;
//! use axa::config::{Config, Defaults};
//! use axa::Environment;
//!
//! async fn hello() -> Result<Response> {
//!     format::json(serde_json::json!({ "hello": "world" }))
//! }
//!
//! # fn main() -> Result<()> {
//! let environment = Environment::Test;
//! let config = Config::from_lookup(
//!     &environment,
//!     &Defaults { database: "", ..Defaults::default() },
//!     |_| None,
//! )?;
//! # #[cfg(not(feature = "sea-orm"))] {
//! let ctx = AppContext::new(environment, (), config);
//! let router = AppRoutes::with_default_routes()
//!     .add_route(Routes::new().prefix("/api").add("/hello", get(hello)))
//!     .into_app(ctx)?;
//! # let _: axum::Router = router;
//! # }
//! # Ok(())
//! # }
//! ```
//!
//! # Features
//!
//! | Feature | Adds |
//! |---|---|
//! | `queue` | The Postgres job queue in [`queue`] |
//! | `testing` | Request-level test helpers in [`testing`] |
//! | `sea-orm` | A SeaORM-backed [`AppContext`], with `axa-seaorm` as `axa::seaorm` |
//! | `redis` | A Redis cache with mandatory expiry, as `axa::redis` |
//! | `diesel` | Diesel pooling, migrations, and test resets in pure Rust, as `axa::diesel` |
//! | `tera` | Tera templates with safe escaping, as `axa::tera` |
//! | `sqlx` | Pooling, migrations, and test resets, as `axa::sqlx` |
//! | `openapi` | `OpenAPI` documents, a pinned Swagger UI, and drift checks, as `axa::openapi` |
//! | `pagination` | Offset pagination and `LIKE` escaping, as `axa::pagination` |
//! | `paseto` | PASETO bearer authentication and ABAC enforcement, as `axa::paseto` |
//! | `problem` | RFC 9457 problem details, as `axa::problem` |
//! | `prometheus` | Prometheus text exposition, as `axa::prometheus` |
//! | `versioning` | `Accepts-version` negotiation, as `axa::versioning` |
//!
//! # Origin
//!
//! The behaviours here are the ones the Main X Index services relied on in
//! [Loco](https://loco.rs). They were written afresh rather than copied, so
//! this crate can keep its own licence terms.

/// Compiles the Rust examples in `README.md`, so they cannot go stale.
#[cfg(all(doctest, not(feature = "sea-orm")))]
#[doc = include_str!("../README.md")]
struct ReadmeDoctests;

pub mod boot;
pub mod cli;
pub mod config;
pub mod context;
pub mod db;
pub mod error;
pub mod format;
pub mod health;
pub mod logger;
pub mod middleware;
pub mod prelude;
#[cfg(feature = "queue")]
pub mod queue;
pub mod routes;
pub mod server;
pub mod store;
pub mod task;
#[cfg(feature = "testing")]
pub mod testing;
pub mod worker;

#[cfg(feature = "diesel")]
pub use axa_diesel as diesel;
pub use axa_environment as environment;
#[cfg(feature = "openapi")]
pub use axa_openapi as openapi;
#[cfg(feature = "pagination")]
pub use axa_pagination as pagination;
#[cfg(feature = "paseto")]
pub use axa_paseto as paseto;
#[cfg(feature = "problem")]
pub use axa_problem as problem;
#[cfg(feature = "prometheus")]
pub use axa_prometheus as prometheus;
#[cfg(feature = "redis")]
pub use axa_redis as redis;
#[cfg(feature = "sea-orm")]
pub use axa_seaorm as seaorm;
#[cfg(feature = "sea-orm")]
pub use axa_seaorm::{model, query, schema, validation};
#[cfg(feature = "sqlx")]
pub use axa_sqlx as sqlx;
#[cfg(feature = "tera")]
pub use axa_tera as tera;
#[cfg(feature = "versioning")]
pub use axa_versioning as versioning;
pub use context::AppContext;
pub use environment::Environment;
pub use error::{Error, Result};
#[cfg(feature = "testing")]
pub use testing::TestServer;