jsonapi_axum 1.0.0-rc.1

axum adapter for jsonapi_core: JSON:API extractors, responders, and tower layers built on jsonapi_http
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

//! [axum](https://docs.rs/axum) adapter for [`jsonapi_core`].
//!
//! This crate is a thin binding: it provides axum's `FromRequest` /
//! `FromRequestParts` / `IntoResponse` impls, delegating all JSON:API logic to
//! [`jsonapi_http`]. If a type here grows real logic, it belongs in
//! `jsonapi_http` instead so other framework adapters can reuse it.
//!
//! # Module map
//!
//! - [`error`] — [`JsonApiError`], the shared rejection + error responder.
//! - [`response`] — [`JsonApiResponse`], an `IntoResponse` wrapper for
//!   documents.
//! - [`extract`] — [`JsonApi`], [`JsonApiQuery`], [`JsonApiQueryValidated`]
//!   extractors.
//! - [`normalize`] — [`not_found`] fallback and [`NormalizeErrorsLayer`] to
//!   JSON:API-shape framework-generated error responses.
//! - [`request_id`] — [`RequestIdLayer`] + [`RequestId`] extractor for
//!   correlation ids on error documents (`errors[].id`) and the `x-request-id`
//!   response header.
//!
//! The framework-agnostic tower layers from [`jsonapi_http`] and the most-used
//! [`jsonapi_core`] types are re-exported so handler code can import from
//! `jsonapi_axum` alone.
#![cfg_attr(docsrs, feature(doc_cfg))]

#[cfg(feature = "atomic-ops")]
#[cfg_attr(docsrs, doc(cfg(feature = "atomic-ops")))]
pub mod atomic;
pub mod error;
pub mod extract;
pub mod normalize;
pub mod pagination;
pub mod relationship;
pub mod request_id;
pub mod response;
#[cfg(any(test, feature = "testing"))]
#[cfg_attr(docsrs, doc(cfg(feature = "testing")))]
pub mod testing;
#[cfg(feature = "validator")]
#[cfg_attr(docsrs, doc(cfg(feature = "validator")))]
pub mod validation;

#[cfg(feature = "atomic-ops")]
#[cfg_attr(docsrs, doc(cfg(feature = "atomic-ops")))]
pub use atomic::AtomicJsonApiResponse;
pub use error::{IntoJsonApiError, JsonApiError, ResultExt};
pub use extract::{BaseUrl, JsonApi, JsonApiQuery, JsonApiQueryValidated, NegotiatedMediaType};
pub use normalize::{NormalizeErrorsLayer, NormalizeErrorsService, not_found};
pub use pagination::{pagination_links, pagination_links_with_base};
pub use relationship::{JsonApiToMany, JsonApiToOne, RelationshipResponse};
pub use request_id::{RequestId, RequestIdLayer, RequestIdService};
pub use response::JsonApiResponse;
#[cfg(feature = "validator")]
#[cfg_attr(docsrs, doc(cfg(feature = "validator")))]
pub use validation::from_validation_errors;

// Re-export the framework-agnostic tower layers so axum users get them from one
// place.
pub use jsonapi_http::{AcceptLayer, ContentTypeLayer, JsonApiLayer};

/// Re-export the fluent [`ApiError`] builder surface so handlers can construct
/// JSON:API errors without importing `jsonapi_http` directly.
pub use jsonapi_http::{ApiErrorExt, ApiErrors, with_status};

/// Re-export the client-id policy so handlers can configure
/// [`JsonApi::check_client_id`](crate::JsonApi::check_client_id) from one place.
pub use jsonapi_http::ClientIdPolicy;

/// Re-export the compound-document `include` resolver so a handler can
/// assemble a deduped `included` array from the requested include paths and a
/// consumer-supplied batch loader.
pub use jsonapi_http::{IncludeResolver, resolve_includes};

/// Re-exports of the [`jsonapi_core`] types most commonly needed to build
/// handlers, so handler bodies can import from `jsonapi_axum` alone.
///
/// **Deriving [`JsonApi`](jsonapi_core::JsonApi) still requires a direct
/// `jsonapi_core` dependency:** the derive macro expands to absolute
/// `::jsonapi_core::…` paths, so the crate must be nameable in the consumer's
/// crate. Only the runtime types are re-exported here.
pub use jsonapi_core::{
    ApiError, CURSOR_PAGINATION_PROFILE, CursorLinks, CursorPage, Document, DocumentBuilder, Field,
    JsonApiMediaType, OffsetPage, PageNumberPage, PageWindow, Query, Relationship, Resource,
    SortField, TypeRegistry,
};

/// The full [`jsonapi_core`] crate, for any type not re-exported above.
pub use jsonapi_core;