Struct ValidatedJson 

pub struct ValidatedJson<T>(pub T);

An Axum extractor that deserializes a JSON request body and validates it with validator.

On success it yields ValidatedJson(value). On failure it short-circuits the handler with a (StatusCode, Json<ApiError>) response:

• malformed JSON -> 400 Bad Request, code INVALID_JSON
• well-formed JSON of the wrong shape -> 422 Unprocessable Entity, code INVALID_BODY
• missing or incorrect Content-Type -> 415 Unsupported Media Type, code UNSUPPORTED_MEDIA_TYPE
• validation failure -> 422 Unprocessable Entity, code VALIDATION_ERROR with field-level details (see ApiError’s From<validator::ValidationErrors> impl)

Requires the validator feature.

Example

use axum_api_kit::ValidatedJson;
use serde::Deserialize;
use validator::Validate;

#[derive(Deserialize, Validate)]
struct CreateUser {
    #[validate(length(min = 1, max = 100))]
    name: String,
    #[validate(email)]
    email: String,
}

// The body is deserialized and validated before the handler body runs.
async fn create_user(ValidatedJson(user): ValidatedJson<CreateUser>) {
    let _ = (user.name, user.email);
}

Tuple Fields

0: T

Trait Implementations

impl<T: Clone> Clone for ValidatedJson<T>

fn clone(&self) -> ValidatedJson<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for ValidatedJson<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, S> FromRequest<S> for ValidatedJson<T>

where T: DeserializeOwned + Validate, S: Send + Sync,

type Rejection = (StatusCode, Json<ApiError>)

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request(req: Request, state: &S) -> Result<Self, Self::Rejection>

Perform the extraction.