gotcha 0.4.0

Enhanced web framework built on top of Axum with OpenAPI, metrics, and configuration management
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

//! # Gotcha Prelude
//!
//! This module contains the most commonly used items from Gotcha.
//! By importing this module, you get everything you need for most applications.
//!
//! ## Example
//!
//! ```no_run
//! use gotcha::prelude::*;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
//!     Gotcha::new()
//!         .get("/", || async { "Hello World" })
//!         .post("/echo", |body: String| async move { body })
//!         .listen("127.0.0.1:3000")
//!         .await?;
//!     Ok(())
//! }
//! ```

// Re-export the most commonly used items

// Core builder API
pub use crate::builder::{EmptyConfig, EmptyState, Gotcha};

// Essential traits and types
pub use crate::config::{ConfigWrapper, GotchaConfigLoader, ServerConfig};
pub use crate::error::{GotchaError, GotchaResult};
pub use crate::router::Responder;
pub use crate::{config, state, GotchaApp, GotchaConfig, GotchaContext, GotchaRouter};

// Common Axum extractors and utilities
pub use axum::extract::ws::{WebSocket, WebSocketUpgrade};
pub use axum::extract::{Extension, Form, Json, Multipart, Path, Query, State};
pub use axum::extract::{MatchedPath, OriginalUri};
pub use axum::http::{HeaderMap, Method, StatusCode};
pub use axum::middleware;
pub use axum::response::sse::{Event, KeepAlive, Sse};
pub use axum::response::{Html, Redirect, Response};
pub use axum::routing::{delete, get, patch, post, put};

// JSON handling
pub use serde::{Deserialize, Serialize};
pub use serde_json::{json, Value as JsonValue};

// Async traits
pub use crate::async_trait;

// Common result type
/// A `Result` whose error defaults to a boxed `std::error::Error`, for `main` and quick handlers.
pub type Result<T, E = Box<dyn std::error::Error + Send + Sync>> = std::result::Result<T, E>;

// Feature-specific exports
#[cfg(feature = "openapi")]
pub use crate::{api, Responsible, Schematic};

#[cfg(feature = "cors")]
pub use crate::layers::CorsLayer;

#[cfg(feature = "task")]
pub use crate::TaskScheduler;

// Utility macros for common patterns
#[macro_export]
/// Defines an async handler function with less ceremony.
macro_rules! handler {
    // Simple async closure handler
    ($body:expr) => {
        || async move { $body }
    };

    // Handler with single parameter
    ($param:ident: $param_type:ty => $body:expr) => {
        |$param: $param_type| async move { $body }
    };
}

#[macro_export]
/// Builds a `Json` response from a `serde_json::json!` literal.
macro_rules! json_response {
    ($data:expr) => {
        axum::Json(serde_json::json!($data))
    };
}

#[macro_export]
/// Starts a server on the given address with the given routes, for examples and prototypes.
macro_rules! quick_server {
    (
        $(($method:ident, $path:literal, $handler:expr)),* $(,)?
    ) => {
        {
            use $crate::prelude::*;
            let mut app = Gotcha::new();
            $(
                app = app.$method($path, $handler);
            )*
            app
        }
    };
}

// Re-export macros
pub use crate::{handler, json_response, quick_server};