/axum-demo

Axum demo

Primary LanguageRust

Axum demo

Axum: ergonomic and modular web framework built with Tokio, Tower, and Hyper.

  • Route requests to handlers with a macro free API.
  • Declaratively parse requests using extractors.
  • Simple and predictable error handling model.
  • Generate responses with minimal boilerplate.
  • Take full advantage of the tower and tower-http ecosystem of middleware, services, and utilities.

Hyper: A fast and correct HTTP implementation for Rust.

  • HTTP/1 and HTTP/2
  • Asynchronous design
  • Leading in performance
  • Tested and correct
  • Extensive production use
  • Client and Server APIs

tower-http: a collection of HTTP specific middleware and utilities built with Tower's Service trait.

  • Trace: Easily add high level tracing/logging to your application. Supports determining success or failure via status codes as well as gRPC specific headers. Has great defaults but also supports deep customization.
  • Compression and Decompression: Automatically compress or decompress response bodies. This goes really well with serving static files using ServeDir.
  • FollowRedirect: Automatically follow redirection responses.

http: a general purpose library of common HTTP types, for examples http::{Request, Response, StatusCode}

Vocabulary

  • Handler: an async function that accepts zero or more “extractors” as arguments and returns something that can be converted into a response.
  • Routing: between handlers and request paths
  • Extractor: a type that implements FromRequest. Extractors are how you pick apart the incoming request to get the parts your handler needs.
  • Building responses: anything that implements IntoResponse can be returned from a handler
  • Middleware: used to decorate the application, providing additional functionality

Demo cases

  • static assets handle
  • index page
  • form submit: login
  • json submit: REST API
  • json output: struct and json!() macro
  • query: /search?q=java
  • Path variables/params /user/:id
  • 404 handler: Separate net("/") and handler_404()

Docker support

Refer from Packaging a Rust web service using Docker

docker build -t axum-demo .
docker run -p 3000:3000 axum-demo

Or you can refer https://kerkour.com/blog/rust-small-docker-image/

Axum Extension

Community Projects: https://github.com/tokio-rs/axum/blob/main/ECOSYSTEM.md

References