https://github.com/linux-china/axum-demo
Axum demo
https://github.com/linux-china/axum-demo
axum rust tokio
Last synced: 3 months ago
JSON representation
Axum demo
- Host: GitHub
- URL: https://github.com/linux-china/axum-demo
- Owner: linux-china
- Created: 2021-07-30T22:38:20.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-01-05T03:44:12.000Z (9 months ago)
- Last Synced: 2025-04-02T02:51:07.344Z (6 months ago)
- Topics: axum, rust, tokio
- Language: Rust
- Homepage:
- Size: 37.1 KB
- Stars: 16
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
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](https://blog.logrocket.com/packaging-a-rust-web-service-using-docker/)
```bash
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
* axum-htmx: https://github.com/robertwayne/axum-htmx
# References
* Axum home: https://github.com/tokio-rs/axum
* Axum examples: https://github.com/tokio-rs/axum/tree/main/examples
* axum-prometheus: Prometheus metrics middleware for Axum https://github.com/ptrskay3/axum-prometheus
* Replacing nginx with axum: https://felix-knorr.net/posts/2024-10-13-replacing-nginx-with-axum.html
* Rust Web Programming - Third Edition: https://learning.oreilly.com/library/view/-/9781835887769/
* Getting Started with Axum - Rust's Most Popular Web Framework: https://www.shuttle.rs/blog/2023/12/06/using-axum-rust
* Introduction to Axum: https://www.youtube.com/playlist?list=PLrmY5pVcnuE-_CP7XZ_44HN-mDrLQV4nS
* Announcing Axum: https://tokio.rs/blog/2021-07-announcing-axum
* Using Rust with Axum for error handling: https://blog.logrocket.com/rust-axum-error-handling/
* How to use “Type safe routing” of axum: https://medium.com/mixi-developers/how-to-use-type-safe-routing-of-axum-c06c1b1b1ab
* How to deploy a Rust Web Server to Heroku using Axum, Docker, and Github Actions: https://fbzga.medium.com/how-to-deploy-a-rust-web-server-to-heroku-using-axum-docker-and-github-actions-6cddb442ea7e
* Deploy a Rust web server to Heroku with axum, Tokio, and GitHub Actions: https://blog.logrocket.com/deploy-rust-web-server-heroku-axum-tokio-github-actions/
* Learning by doing: An HTTP API with Rust: https://blog.frankel.ch/http-api-rust/
* Building a Proxy Server in Rust with Axum: https://medium.com/dev-genius/building-a-proxy-server-in-rust-with-axum-4d1e0215a6b0
* Writing a Rest HTTP Service with Axum: https://docs.shuttle.rs/tutorials/rest-http-service-with-axum
* API Evolution in axum: https://www.youtube.com/watch?v=w1atdqNsA80
* Bundle frontend into axum binary using include_dir: https://dev.to/konstantin/bundle-frontend-with-axum-build-using-includedir-g8i
* Extracting Generic Substates in Axum: https://mhu.dev/posts/2024-07-02-axum-generic-substate/
* Using Axum Framework To Create REST API:
- https://medium.com/intelliconnect-engineering/using-axum-framework-to-create-rest-api-part-1-7d434d2c5de4
- https://medium.com/intelliconnect-engineering/using-axum-framework-to-create-rest-api-part-ii-4eba129c196b