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
//! Web framework based on [Springtime](https://crates.io/crates/springtime) and axum.
//!
//! `axum` is a web application framework built with a imperative approach - integration with
//! *Springtime* allows for declarative approach to creating handlers (called here
//! [*Controllers*](controller::Controller)) which can take full advantage of dependency injection.
//!
//! ### Simple usage example
//!
//! ```no_run
//! use axum::extract::Path;
//! use springtime::application;
//! use springtime_di::Component;
//! use springtime_web_axum::controller;
//!
//! // create a struct which will serve as our Controller - this implies it
//! // needs to be a Component for the dependency injection to work
//! #[derive(Component)]
//! struct ExampleController;
//!
//! // mark the struct as a Controller - this will scan all functions for the
//! // controller attributes and create axum handlers out of them
//! #[controller]
//! impl ExampleController {
//! // this function will respond to GET request for http://localhost/ (or
//! // any network interface)
//! #[get("/")]
//! async fn hello_world(&self) -> &'static str {
//! "Hello world!"
//! }
//! }
//!
//! // note: for the sake of simplicity, errors are unwrapped, rather than
//! // gracefully handled
//! #[tokio::main]
//! async fn main() {
//! let mut application =
//! application::create_default().expect("unable to create application");
//!
//! // run our server with default configuration - requests should be
//! // forwarded to ExampleController
//! application.run().await.expect("error running application");
//! }
//! ```
//!
//! ### Features
//!
//! * `derive` - automatically import helper proc macros
pub mod config;
pub mod controller;
pub mod router;
pub mod server;
pub use axum;
#[cfg(feature = "derive")]
pub use springtime_web_axum_derive::*;