axum_api_kit/
lib.rs

1//! Shared response types for Axum JSON APIs.
2//!
3//! Provides building blocks that every Axum CRUD service needs but always
4//! re-defines from scratch:
5//!
6//! - [`ApiError`] - a machine-readable JSON error body with `code`, `message`, and optional
7//!   `details`, plus factory helpers that return `(StatusCode, Json<ApiError>)` tuples ready
8//!   for use with Axum's [`IntoResponse`](axum::response::IntoResponse). Supports `From`
9//!   conversions for common error types. With the optional `validator` feature enabled,
10//!   also supports converting `validator::ValidationErrors` into structured field errors.
11//!   With the optional `sqlx` feature enabled, also supports converting `sqlx::Error` into
12//!   semantically correct HTTP status codes (404, 409, 422, 503, 500).
13//! - [`ListResponse<T>`] - a generic offset/limit paginated collection response with `data`,
14//!   `total`, `limit`, and `offset` fields.
15//! - [`CursorResponse<T>`] - a generic cursor-based paginated collection response for large
16//!   datasets or feeds, with `data`, `next_cursor`, and `has_more` fields.
17//! - [`HealthResponse`] - a health-check response with `status` field supporting `ok`,
18//!   `degraded`, and `unhealthy` states.
19//!
20//! With optional feature flags enabled, the kit also provides request extractors that
21//! reject with an [`ApiError`] body on failure:
22//!
23//! - `ValidatedJson<T>` (feature `validator`) - deserializes a JSON body and runs
24//!   `validator` validation before the handler runs.
25//! - `Pagination` and `CursorPagination` (feature `extract`) - parse `limit`/`offset` and
26//!   `cursor`/`limit` query parameters into typed values, with `list_response` /
27//!   `cursor_response` helpers that build the matching response type.
28//!
29//! It also ships observability middleware:
30//!
31//! - `propagate_request_id` and `trace_requests` (feature `trace`) - assign an
32//!   `x-request-id` correlation id (extractable via `RequestId`) and emit a structured
33//!   `tracing` event with method, path, status, and latency for each request.
34//!
35//! And service-wiring helpers:
36//!
37//! - `health_routes` and `liveness` (feature `router`) - a `Router` exposing `/healthz` and
38//!   `/readyz` probes backed by `HealthResponse`.
39//! - `cors_allowing` and `permissive_cors` (feature `cors`) - build a `tower_http`
40//!   `CorsLayer` with sensible defaults.
41//!
42//! # Quick Start
43//!
44//! ```rust,no_run
45//! use axum::{Json, http::StatusCode, response::IntoResponse};
46//! use axum_api_kit::{ApiError, ListResponse, CursorResponse, HealthResponse};
47//! use serde::Serialize;
48//!
49//! #[derive(Serialize)]
50//! struct Item { id: String }
51//!
52//! async fn list_items() -> impl IntoResponse {
53//!     let items = vec![Item { id: "1".into() }];
54//!     Json(ListResponse { data: items, total: 1, limit: 50, offset: 0 })
55//! }
56//!
57//! async fn feed_items(cursor: Option<String>) -> impl IntoResponse {
58//!     let items = vec![Item { id: "1".into() }];
59//!     CursorResponse { data: items, next_cursor: Some("abc".into()), has_more: true }
60//! }
61//!
62//! async fn get_item() -> impl IntoResponse {
63//!     ApiError::not_found("item not found")
64//! }
65//!
66//! async fn health() -> impl IntoResponse {
67//!     HealthResponse::ok()
68//! }
69//! ```
70
71#[cfg(feature = "cors")]
72mod cors;
73mod cursor;
74mod error;
75mod health;
76mod list;
77#[cfg(feature = "extract")]
78mod pagination;
79#[cfg(feature = "router")]
80mod router;
81#[cfg(feature = "trace")]
82mod trace;
83#[cfg(feature = "validator")]
84mod validated;
85
86#[cfg(feature = "cors")]
87pub use cors::{cors_allowing, permissive_cors};
88pub use cursor::CursorResponse;
89pub use error::ApiError;
90pub use health::HealthResponse;
91pub use list::ListResponse;
92#[cfg(feature = "extract")]
93pub use pagination::{CursorPagination, Pagination};
94#[cfg(feature = "router")]
95pub use router::{health_routes, liveness};
96#[cfg(feature = "trace")]
97pub use trace::{propagate_request_id, trace_requests, RequestId, REQUEST_ID_HEADER};
98#[cfg(feature = "validator")]
99pub use validated::ValidatedJson;
axum_api_kit/lib.rs

axum_api_kit/
lib.rs
