Module axum_valid::yaml
source · Expand description
§Support for Yaml<T>
from axum-serde
§Feature
Enable the yaml
feature to use Valid<Yaml<T>>
.
§Usage
- Implement
Deserialize
andValidate
for your data typeT
. - In your handler function, use
Valid<Yaml<T>>
as some parameter’s type.
§Example
#[cfg(feature = "validator")]
mod validator_example {
use axum::routing::post;
use axum_serde::Yaml;
use axum::Router;
use axum_valid::Valid;
use serde::Deserialize;
use validator::Validate;
pub fn router() -> Router {
Router::new().route("/yaml", post(handler))
}
async fn handler(Valid(Yaml(parameter)): Valid<Yaml<Parameter>>) {
assert!(parameter.validate().is_ok());
// Support automatic dereferencing
println!("v0 = {}, v1 = {}", parameter.v0, parameter.v1);
}
#[derive(Validate, Deserialize)]
pub struct Parameter {
#[validate(range(min = 5, max = 10))]
pub v0: i32,
#[validate(length(min = 1, max = 10))]
pub v1: String,
}
}
#[cfg(feature = "garde")]
mod garde_example {
use axum::routing::post;
use axum_serde::Yaml;
use axum::Router;
use axum_valid::Garde;
use serde::Deserialize;
use garde::Validate;
pub fn router() -> Router {
Router::new().route("/yaml", post(handler))
}
async fn handler(Garde(Yaml(parameter)): Garde<Yaml<Parameter>>) {
assert!(parameter.validate(&()).is_ok());
// Support automatic dereferencing
println!("v0 = {}, v1 = {}", parameter.v0, parameter.v1);
}
#[derive(Validate, Deserialize)]
pub struct Parameter {
#[garde(range(min = 5, max = 10))]
pub v0: i32,
#[garde(length(min = 1, max = 10))]
pub v1: String,
}
}