6 releases
0.2.2 | Jul 18, 2024 |
---|---|
0.2.1 | Jul 18, 2024 |
0.1.2 | Jul 18, 2024 |
#1579 in Web programming
84 downloads per month
19KB
81 lines
autortr_rocket
autortr_rocket
is a lightweight Rust library designed for automatic route mapping in web applications
for the Rocket
framework. It simplifies the process of defining and managing HTTP
routes by automatically
registering functions annotated with custom attributes like #[request_mapping]
Or #[get_mapping]
, #[post_mapping]
, #[patch_mapping]
, #[put_mapping]
,#[delete_mapping]
and #[head_mapping]
.
1.Usage
Add this to your Cargo.toml
:
[dependencies]
autortr_rocket = "0.2"
# And
# If necessary
rocket = "${version}"
lazy_static = "${version}"
ctor = "${version}"
2.APIs
2.0.Macros
#[request_mapping]
namespace
method
GET
POST
PUT
PATCH
DELETE
HEAD
path
data
<form>
- …
get_mapping
default
#[get_mapping("${path}")]
namespace
path
data
<form>
post_mapping
- Same as above(
get_mapping
)
- Same as above(
put_mapping
- Same as above(
get_mapping
)
- Same as above(
patch_mapping
- Same as above(
get_mapping
)
- Same as above(
delete_mapping
- Same as above(
get_mapping
)
- Same as above(
head_mapping
- Same as above(
get_mapping
)
- Same as above(
2.1.Import
use autortr_rocket::prelude::*;
2.2.Controller
API
functions.
2.2.1.GET
// Default mount base-path is: "/"
app.mount("/", routes![get_fn]);
// GET: method == get; path == "/get"
// -> rocket: #[get("/get")]
// -> HTTP: http://127.0.0.1:8000/get
#[request_mapping(method = "get", path = "/get")]
fn get_fn() -> &'static str {
"Hello, get!"
}
2.2.2.POST
// POST: method == post; path == "/post"
// -> rocket: #[post("/post")]
// -> HTTP: http://127.0.0.1:8000/post
#[request_mapping(method = "post", path = "/post")]
fn post_fn() -> &'static str {
"Hello, post!"
}
2.2.3.PUT
// PUT: method == put; path == "/put"
// -> rocket: #[put("/put")]
// -> HTTP: http://127.0.0.1:8000/put
#[request_mapping(method = "put", path = "/put")]
fn puf_fn() -> &'static str {
"Hello, put!"
}
2.2.4.PATCH
// PATCH: method == patch; path == "/patch"
// -> rocket: #[patch("/patch")]
// -> HTTP: http://127.0.0.1:8000/patch
#[request_mapping(method = "patch", path = "/patch")]
fn patch_fn() -> &'static str {
"Hello, patch!"
}
2.2.5.DELETE
// DELETE: method == delete; path == "/delete"
// -> rocket: #[delete("/delete")]
// -> HTTP: http://127.0.0.1:8000/delete
#[request_mapping(method = "delete", path = "/delete")]
fn delete_fn() -> &'static str {
"Hello, delete!"
}
2.2.5.Namespace
Custom mount base-path by namespace
attribute.
Rocket's
base
app.mount("/namespace", routes![namespace_fn]);
// GET: namespace == rocket, method == get; path == "/namespace"
// -> rocket: #[get("/namespace")]
// -> rocket: mount: /rocket/namespace
// -> HTTP: http://127.0.0.1:8000/rocket/namespace
#[request_mapping(namespace = "/rocket", method = "get", path = "/namespace")]
fn namespace_fn() -> &'static str {
"Hello, namespace!"
}
2.3.App instance
fn configure() -> AdHoc {
AdHoc::on_ignite("Configure Rocket", |rocket| async {
println!("Running additional initialization");
rocket
})
}
// ----------------------------------------------------------------
// 1.Populate Rocket instance.
// -> auto-mount by Autortr
let rocket_app = app(); // Rocket<Build>
// 2.Configure
// rocket_app.[...]
// 3.Launch
// let _ = app.attach(configure())[.xxx.yyy.zzz].launch().await?;
let _ = rocket_app.attach(configure()).launch().await?;
Ok(())
2.3.1.launch
#[rocket::launch]
fn rocket() -> _ {
let app = app();
app.attach(configure())
}
2.3.2.main
#[rocket::main]
async fn main() -> Result<(), rocket::Error> {
let app = app();
let _ = app.attach(configure()).launch().await?;
Ok(())
}
2.4.Next
2.4.1.Other's web framework
- …
Dependencies
~15–47MB
~790K SLoC