rustapi_core/
lib.rs

1//! # RustAPI Core
2//!
3//! Core library providing the foundational types and traits for RustAPI.
4//!
5//! This crate provides the essential building blocks for the RustAPI web framework:
6//!
7//! - **Application Builder**: [`RustApi`] - The main entry point for building web applications
8//! - **Routing**: [`Router`], [`get`], [`post`], [`put`], [`patch`], [`delete`] - HTTP routing primitives
9//! - **Extractors**: [`Json`], [`Query`], [`Path`], [`State`], [`Body`], [`Headers`] - Request data extraction
10//! - **Responses**: [`IntoResponse`], [`Created`], [`NoContent`], [`Html`], [`Redirect`] - Response types
11//! - **Middleware**: [`BodyLimitLayer`], [`RequestIdLayer`], [`TracingLayer`] - Request processing layers
12//! - **Error Handling**: [`ApiError`], [`Result`] - Structured error responses
13//! - **Testing**: `TestClient` - Integration testing without network binding (requires `test-utils` feature)
14//!
15//! ## Quick Start
16//!
17//! ```rust,ignore
18//! use rustapi_core::{RustApi, get, Json};
19//! use serde::Serialize;
20//!
21//! #[derive(Serialize)]
22//! struct Message {
23//!     text: String,
24//! }
25//!
26//! async fn hello() -> Json<Message> {
27//!     Json(Message { text: "Hello, World!".to_string() })
28//! }
29//!
30//! #[tokio::main]
31//! async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
32//!     RustApi::new()
33//!         .route("/", get(hello))
34//!         .run("127.0.0.1:8080")
35//!         .await
36//! }
37//! ```
38//!
39//! ## Feature Flags
40//!
41//! - `metrics` - Enable Prometheus metrics middleware
42//! - `cookies` - Enable cookie parsing extractor
43//! - `test-utils` - Enable testing utilities like `TestClient`
44//! - `swagger-ui` - Enable Swagger UI documentation endpoint
45//!
46//! ## Note
47//!
48//! This crate is typically not used directly. Use `rustapi-rs` instead for the
49//! full framework experience with all features and re-exports.
50
51mod app;
52pub mod auto_route;
53pub use auto_route::collect_auto_routes;
54pub mod auto_schema;
55pub use auto_schema::apply_auto_schemas;
56mod error;
57mod extract;
58mod handler;
59pub mod middleware;
60pub mod multipart;
61pub mod path_validation;
62mod request;
63mod response;
64mod router;
65mod server;
66pub mod sse;
67pub mod static_files;
68pub mod stream;
69#[cfg(any(test, feature = "test-utils"))]
70mod test_client;
71
72/// Private module for macro internals - DO NOT USE DIRECTLY
73///
74/// This module is used by procedural macros to register routes.
75/// It is not part of the public API and may change at any time.
76#[doc(hidden)]
77pub mod __private {
78    pub use crate::auto_route::AUTO_ROUTES;
79    pub use crate::auto_schema::AUTO_SCHEMAS;
80    pub use linkme;
81    pub use rustapi_openapi;
82}
83
84// Public API
85pub use app::{RustApi, RustApiConfig};
86pub use error::{get_environment, ApiError, Environment, Result};
87#[cfg(feature = "cookies")]
88pub use extract::Cookies;
89pub use extract::{
90    Body, ClientIp, Extension, FromRequest, FromRequestParts, HeaderValue, Headers, Json, Path,
91    Query, State, ValidatedJson,
92};
93pub use handler::{
94    delete_route, get_route, patch_route, post_route, put_route, Handler, HandlerService, Route,
95    RouteHandler,
96};
97#[cfg(feature = "compression")]
98pub use middleware::CompressionLayer;
99pub use middleware::{BodyLimitLayer, RequestId, RequestIdLayer, TracingLayer, DEFAULT_BODY_LIMIT};
100#[cfg(feature = "metrics")]
101pub use middleware::{MetricsLayer, MetricsResponse};
102pub use multipart::{Multipart, MultipartConfig, MultipartField, UploadedFile};
103pub use request::Request;
104pub use response::{Created, Html, IntoResponse, NoContent, Redirect, Response, WithStatus};
105pub use router::{delete, get, patch, post, put, MethodRouter, Router};
106pub use sse::{sse_response, KeepAlive, Sse, SseEvent};
107pub use static_files::{serve_dir, StaticFile, StaticFileConfig};
108pub use stream::StreamBody;
109#[cfg(any(test, feature = "test-utils"))]
110pub use test_client::{TestClient, TestRequest, TestResponse};
rustapi_core/lib.rs

rustapi_core/
lib.rs
