Demo of Rust and Axum -- seeking feedback

[joelparkerhenderson]

Hi, Axum looks great! I'm writing a demo of Rust and Axum that's a tutorial especially for new users. I'm seeking feedback from Axum users and developers, for ideas, suggestions, any code quality feedback, etc. Thank you. Best, Joel.

https://github.com/joelparkerhenderson/demo-rust-axum

[davidpdrsn]

Awesome! Feel free to make a PR adding it to ECOSYSTEM.md when you feel its ready 😊

Some quick things I noticed:

• We generally write axum all lowercase, though not totally consistently. I prefer it lowercase though 😅
• Don't use * when declaring dependencies. Use version numbers instead, otherwise you dunno which version people will get in the future.
• You don't need to write extern crate _ anymore. Rust does that automatically.
• Should probably explain the syntax Json(payload): Json<serde_json::Value> in function arguments. It confuses some beginners.
• You can also initialize the books inside the call to Lazy::new. Doesn't need to be a separate function.

[jplatte]

It looks like to follow your example, one would rerun the app a lot. Given graceful shutdown isn't set up, I think in some circumstances the app might hang when you want to abort it. See the graceful shutdown example.

Also in 10., you set a request content-type of json even though you don't send any json. I would recommend you remove that and add the -I flag to the curl command so it shows the response headers.

[joelparkerhenderson]

^ Good feedback @jplatte, thank you. I'll add those next.

[joelparkerhenderson]

Added. See new README section 2. I also added info from the hyper docs and the tokio docs, which both have good explanations IMHO.

Does this update add enough for what you're suggesting?

In particular, the demo code now handles the tokio signal CTRL-C. I see your example that handles more, such as Unix and non-Unix areas. For this tutorial, how important are these to you?

My goal is to get the reader serving content quickly because I believe that this gets a beginner to reach an "aha" moment.

[jplatte]

Yeah it makes a lot of sense to me to only do the Ctrl+C thing. People will realize that they generally have to do that stuff themselves and can choose a different way of triggering graceful shutdow.

I just noticed a new thing though, you created a Response manually for the PNG example:

let body = axum::body::Full::from(::base64::decode(png).unwrap());
let mut response = axum::response::Response::new(body);
response.headers_mut().insert(
    ::http::header::CONTENT_TYPE,
    ::http::header::HeaderValue::from_static("image/png")
);
response

This can greatly be simplified to

(
    axum::response::Headers([(http::header::CONTENT_TYPE, "image/png")]),
    base64::decode(png).unwrap(),
)

[joelparkerhenderson]

Much simpler, thank you. I updated it now.