A body extractor for the Axum web framework.
- Supports encoding and decoding of various formats with a single extractor.
- Provides a wrapper for
axum::routing::method_routing
to automatically encode responses in the correct format according to the specifiedAccept
header (with a fallback toContent-Type
, then one of the enabled formats). - Provides an attribute macro (under the
macros
feature) to add derives for all enabled formats to a struct/enum.
- Support
bitcode
,bincode
,ciborium
,rmp
,toml
,serde_yaml
, andserde_json
- Add custom
MethodRouter
to automatically encode responses in the correct format - Add macro to derive all enabled formats for a struct/enum
- Add support for
aide
- Add support for
validator
- Support more formats (issues and PRs welcome)
- Add benchmarks?
Here's a quick example that can do the following:
- Decode a
User
from the request body in any of the supported formats. - Encode a
Greeting
to the response body in any of the supported formats.
use axum::{Router, response::IntoResponse};
use axum_codec::{
response::IntoCodecResponse,
routing::{get, post},
Codec, Accept,
};
// Shorthand for the following (assuming all features are enabled):
//
// #[derive(
// serde::Serialize, serde::Deserialize,
// bincode::Encode, bincode::Decode,
// bitcode::Encode, bitcode::Decode,
// validator::Validate,
// )]
// #[serde(crate = "...")]
// #[bincode(crate = "...")]
// #[bitcode(crate = "...")]
// #[validator(crate = "...")]
#[axum_codec::apply(encode, decode)]
struct User {
name: String,
age: u8,
}
async fn me() -> Codec<User> {
Codec(User {
name: "Alice".into(),
age: 42,
})
}
/// A manual implementation of the handler above.
async fn manual_me(accept: Accept) -> impl IntoResponse {
Codec(User {
name: "Alice".into(),
age: 42,
})
.into_codec_response(accept.into())
}
#[axum_codec::apply(encode)]
struct Greeting {
message: String,
}
/// Specify `impl IntoCodecResponse`, similar to `axum`
async fn greet(Codec(user): Codec<User>) -> impl IntoCodecResponse {
Codec(Greeting {
message: format!("Hello, {}! You are {} years old.", user.name, user.age),
})
}
#[tokio::main]
async fn main() {
let app: Router = Router::new()
.route("/me", get(me).into())
.route("/manual", axum::routing::get(manual_me))
.route("/greet", post(greet).into());
let listener = tokio::net::TcpListener::bind(("127.0.0.1", 3000))
.await
.unwrap();
// axum::serve(listener, app).await.unwrap();
}
macros
: Enables theaxum_codec::apply
attribute macro.json
*: EnablesJSON
support.msgpack
: EnablesMessagePack
support.bincode
: EnablesBincode
support.bitcode
: EnablesBitcode
support.cbor
: EnablesCBOR
support.yaml
: EnablesYAML
support.toml
: EnablesTOML
support.aide
: Enables support for theAide
documentation library.validator
: Enables support for theValidator
validation library, validating all input when extracted withCodec<T>
.
- Enabled by default.
Dual-licensed under MIT or Apache License v2.0.