api_bones/
lib.rs

1//! # api-bones
2//!
3//! Opinionated REST API types: errors (RFC 9457), pagination, health checks, and more.
4//!
5//! ## `no_std` support
6//!
7//! This crate is `#![no_std]` when the default `std` feature is disabled.
8//!
9//! | Features enabled         | Available types                                    |
10//! |--------------------------|-----------------------------------------------------|
11//! | *(none)*                 | Pure-`core` types: `ErrorCode`, `HealthStatus`, `PaginationParams`, `SortDirection` |
12//! | `alloc`                  | All types that use `String`/`Vec`/`Arc`             |
13//! | `std` *(default)*        | Full feature set including `HashMap`-backed types   |
14//!
15//! ```toml
16//! # no_std + alloc (WASM, embedded with allocator)
17//! api-bones = { version = "...", default-features = false, features = ["alloc"] }
18//!
19//! # pure no_std (core types only)
20//! api-bones = { version = "...", default-features = false }
21//! ```
22//!
23//! ## Core type: [`ApiError`]
24//!
25//! Every service serializes errors into [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457)
26//! Problem Details format:
27//!
28//! ```json
29//! {
30//!   "type": "urn:api-bones:error:resource-not-found",
31//!   "title": "Resource Not Found",
32//!   "status": 404,
33//!   "detail": "Booking 123 not found"
34//! }
35//! ```
36//!
37//! ```rust
38//! use api_bones::{ApiError, ErrorCode};
39//!
40//! fn find_booking(id: u64) -> Result<(), ApiError> {
41//!     Err(ApiError::not_found(format!("booking {id} not found")))
42//! }
43//! ```
44//!
45//! ## Feature flags (selection)
46//!
47//! | Feature    | What it enables                                      |
48//! |------------|------------------------------------------------------|
49//! | `schemars` | [`schemars::JsonSchema`] derive on all public types  |
50//! | `utoipa`   | [`utoipa::ToSchema`] derive on all public types      |
51//!
52//! Enable `schemars` in your `Cargo.toml`:
53//!
54//! ```toml
55//! api-bones = { version = "3", features = ["schemars"] }
56//! ```
57//!
58//! ## Add as dependency
59//!
60//! ```toml
61//! [dependencies]
62//! api-bones = "3"
63//! ```
64
65#![cfg_attr(not(feature = "std"), no_std)]
66
67// When `std` is not available but `alloc` is, bring the alloc crate into scope.
68// Under `std`, the `alloc` crate is re-exported by `std` so no explicit import
69// is needed.
70#[cfg(all(not(feature = "std"), feature = "alloc"))]
71extern crate alloc;
72
73// Auth module: requires the `auth` feature (implies alloc + base64 + zeroize).
74#[cfg(feature = "auth")]
75pub mod auth;
76
77// Modules that require heap allocation (String / Vec / Arc).
78#[cfg(any(feature = "std", feature = "alloc"))]
79pub mod audit;
80#[cfg(any(feature = "std", feature = "alloc"))]
81pub mod bulk;
82#[cfg(any(feature = "std", feature = "alloc"))]
83pub mod cache;
84#[cfg(all(any(feature = "std", feature = "alloc"), feature = "uuid"))]
85pub mod correlation_id;
86#[cfg(any(feature = "std", feature = "alloc"))]
87pub mod cors;
88#[cfg(feature = "base64")]
89pub mod cursor;
90#[cfg(any(feature = "std", feature = "alloc"))]
91pub mod deprecated;
92#[cfg(any(feature = "std", feature = "alloc"))]
93pub mod etag;
94#[cfg(any(feature = "std", feature = "alloc"))]
95pub mod header_id;
96#[cfg(all(any(feature = "std", feature = "alloc"), feature = "uuid"))]
97pub mod idempotency;
98#[cfg(any(feature = "std", feature = "alloc"))]
99pub mod links;
100#[cfg(all(any(feature = "std", feature = "alloc"), feature = "uuid"))]
101pub mod org_context;
102#[cfg(all(any(feature = "std", feature = "alloc"), feature = "uuid"))]
103pub mod org_id;
104#[cfg(any(feature = "std", feature = "alloc"))]
105pub mod range;
106#[cfg(all(any(feature = "std", feature = "alloc"), feature = "uuid"))]
107pub mod request_id;
108#[cfg(any(feature = "std", feature = "alloc"))]
109pub mod response;
110#[cfg(any(feature = "std", feature = "alloc"))]
111pub mod slug;
112#[cfg(all(any(feature = "std", feature = "alloc"), feature = "uuid"))]
113pub mod traceparent;
114#[cfg(any(feature = "std", feature = "alloc"))]
115pub mod url;
116#[cfg(any(feature = "std", feature = "alloc"))]
117pub mod vary;
118pub mod version;
119
120// Modules available in all configurations; individual types inside are gated
121// where they require `alloc` or `std`.
122pub mod common;
123pub mod error;
124pub mod health;
125pub mod method;
126pub mod pagination;
127pub mod query;
128pub mod ratelimit;
129pub mod retry;
130pub mod status;
131
132#[cfg(any(feature = "std", feature = "alloc"))]
133pub mod content_type;
134
135#[cfg(feature = "http")]
136pub mod header;
137
138#[cfg(all(feature = "serde", any(feature = "std", feature = "alloc")))]
139pub mod serde;
140
141#[cfg(feature = "fake")]
142mod fake_impls;
143
144#[cfg(feature = "icalendar")]
145pub mod calendar;
146
147// OpenAPI helpers: Example<T> and DeprecatedField (issues #119, #120).
148pub mod openapi;
149
150pub mod has_id;
151pub use has_id::HasId;
152
153// Axum extractors beyond IntoResponse (issue #121).
154#[cfg(feature = "axum")]
155pub mod axum_extractors;
156
157#[cfg(any(feature = "std", feature = "alloc"))]
158pub use audit::{
159    AuditInfo, Principal, PrincipalId, PrincipalKind, PrincipalParseError, ResolvedPrincipal,
160};
161#[cfg(feature = "auth")]
162pub use auth::{
163    ApiKeyCredentials, AuthScheme, AuthorizationHeader, BasicCredentials, BearerToken, OAuth2Token,
164    ParseAuthorizationError, ParsePermissionError, ParseScopeError, Permission, Scope,
165};
166#[cfg(any(feature = "std", feature = "alloc"))]
167pub use bulk::{BulkItemResult, BulkRequest, BulkResponse};
168#[cfg(feature = "uuid")]
169pub use common::ResourceId;
170#[cfg(feature = "uuid")]
171pub use common::new_resource_id;
172#[cfg(feature = "chrono")]
173pub use common::parse_timestamp;
174// Timestamp is chrono::DateTime when chrono is on (no alloc needed),
175// or String when chrono is off (needs alloc or std).
176#[cfg(any(feature = "std", feature = "alloc"))]
177pub use cache::CacheControl;
178#[cfg(any(feature = "chrono", feature = "std", feature = "alloc"))]
179pub use common::Timestamp;
180#[cfg(any(feature = "std", feature = "alloc"))]
181pub use content_type::ContentType;
182#[cfg(all(any(feature = "std", feature = "alloc"), feature = "uuid"))]
183pub use correlation_id::{CorrelationId, CorrelationIdError};
184#[cfg(any(feature = "std", feature = "alloc"))]
185pub use cors::{CorsHeaders, CorsOrigin};
186#[cfg(feature = "base64")]
187pub use cursor::{Cursor, CursorError};
188#[cfg(any(feature = "std", feature = "alloc"))]
189pub use deprecated::Deprecated;
190pub use error::ErrorCode;
191#[cfg(any(feature = "std", feature = "alloc"))]
192pub use error::ErrorTypeMode;
193#[cfg(any(feature = "std", feature = "alloc"))]
194pub use error::HttpError;
195#[cfg(all(any(feature = "std", feature = "alloc"), feature = "serde"))]
196pub use error::ProblemJson;
197#[cfg(any(feature = "std", feature = "alloc"))]
198pub use error::{ApiError, ValidationError};
199#[cfg(feature = "std")]
200pub use error::{error_type_mode, set_error_type_mode, urn_namespace};
201#[cfg(any(feature = "std", feature = "alloc"))]
202pub use etag::{ETag, IfMatch, IfNoneMatch};
203#[cfg(feature = "http")]
204pub use header::{HeaderName, HeaderValue};
205#[cfg(any(feature = "std", feature = "alloc"))]
206pub use header_id::HeaderId;
207pub use health::HealthStatus;
208#[cfg(feature = "std")]
209pub use health::ReadinessResponse;
210#[cfg(any(feature = "std", feature = "alloc"))]
211pub use health::{HealthCheck, LivenessResponse};
212#[cfg(all(any(feature = "std", feature = "alloc"), feature = "uuid"))]
213pub use idempotency::{IdempotencyKey, IdempotencyKeyError};
214#[cfg(any(feature = "std", feature = "alloc"))]
215pub use links::{Link, Links};
216pub use method::HttpMethod;
217#[cfg(all(any(feature = "std", feature = "alloc"), feature = "uuid"))]
218pub use org_context::{
219    Attestation, AttestationKind, OrganizationContext, Role, RoleBinding, RoleScope,
220};
221#[cfg(all(
222    any(feature = "std", feature = "alloc"),
223    feature = "uuid",
224    feature = "http"
225))]
226pub use org_id::OrgIdHeaderError;
227#[cfg(all(any(feature = "std", feature = "alloc"), feature = "uuid"))]
228pub use org_id::{OrgId, OrgIdError, OrgPath};
229pub use pagination::PaginationParams;
230#[cfg(any(feature = "std", feature = "alloc"))]
231pub use pagination::{
232    CursorPaginatedResponse, CursorPagination, CursorPaginationParams, PaginatedResponse,
233};
234#[cfg(any(feature = "std", feature = "alloc"))]
235pub use pagination::{KeysetPaginatedResponse, KeysetPaginationParams};
236pub use query::SortDirection;
237#[cfg(any(feature = "std", feature = "alloc"))]
238pub use query::{FilterEntry, FilterParams, SearchParams, SortParams};
239#[cfg(any(feature = "std", feature = "alloc"))]
240pub use range::{ByteRange, ContentRange, ParseRangeError, RangeHeader};
241#[cfg(any(feature = "std", feature = "alloc"))]
242pub use ratelimit::RateLimitInfo;
243#[cfg(all(any(feature = "std", feature = "alloc"), feature = "uuid"))]
244pub use request_id::{RequestId, RequestIdError, RequestIdParseError};
245#[cfg(any(feature = "std", feature = "alloc"))]
246pub use response::{ApiResponse, ApiResponseBuilder, ResponseMeta};
247pub use retry::{BackoffStrategy, Idempotent, RetryPolicy};
248#[cfg(any(feature = "std", feature = "alloc"))]
249pub use retry::{RetryAfter, RetryAfterParseError};
250#[cfg(any(feature = "std", feature = "alloc"))]
251pub use slug::{Slug, SlugError};
252pub use status::StatusCode;
253#[cfg(all(any(feature = "std", feature = "alloc"), feature = "uuid"))]
254pub use traceparent::{SamplingFlags, SpanId, TraceContext, TraceContextError, TraceId};
255#[cfg(any(feature = "std", feature = "alloc"))]
256pub use url::{QueryBuilder, UrlBuilder};
257#[cfg(any(feature = "std", feature = "alloc"))]
258pub use vary::Vary;
259pub use version::{ApiVersion, ApiVersionParseError, SemverTriple};
api_bones/lib.rs

api_bones/
lib.rs
