axum-valid

This crate provides a Valid type that can be used in combination with Json, Path, Query, and Form extractors to validate the entities that implement the Validate trait from the validator crate.

Additional extractors like TypedHeader, MsgPack, Yaml etc. are supported through optional features. The full list of supported extractors is in the Features section below.

Basic usage

shell cargo add axum-valid

```rust,norun use validator::Validate; use serde::Deserialize; use axumvalid::Valid; use axum::extract::Query; use axum::{Json, Router}; use axum::routing::{get, post};

[derive(Debug, Validate, Deserialize)]

pub struct Pager { #[validate(range(min = 1, max = 50))] pub pagesize: usize, #[validate(range(min = 1))] pub pageno: usize, }

pub async fn pagerfromquery( Valid(Query(pager)): Valid>, ) { assert!((1..=50).contains(&pager.pagesize)); assert!((1..).contains(&pager.pageno)); }

pub async fn pagerfromjson( Valid(Json(pager)): Valid>, ) { assert!((1..=50).contains(&pager.pagesize)); assert!((1..).contains(&pager.pageno)); }

[tokio::main]

async fn main() -> anyhow::Result<()> { let router = Router::new() .route("/query", get(pagerfromquery)) .route("/json", post(pagerfromjson)); axum::Server::bind(&([0u8, 0, 0, 0], 8080).into()) .serve(router.intomakeservice()) .await?; Ok(()) } ```

When validation errors occur, the extractor will automatically return 400 with validation errors as the HTTP message body.

To see how each extractor can be used with Valid, please refer to the example in the documentation of the corresponding module.

Features

| Feature | Description | Default | Example | Tests | |------------------|------------------------------------------------------------------------------------------------------|---------|---------|-------| | default | Enables support for Path, Query, Json and Form | ✅ | ✅ | ✅ | | json | Enables support for Json | ✅ | ✅ | ✅ | | query | Enables support for Query | ✅ | ✅ | ✅ | | form | Enables support for Form | ✅ | ✅ | ✅ | | typedheader | Enables support for TypedHeader | ❌ | ✅ | ✅ | | typedmultipart | Enables support for TypedMultipart and BaseMultipart from axum_typed_multipart | ❌ | ✅ | ✅ | | msgpack | Enables support for MsgPack and MsgPackRaw from axum-msgpack | ❌ | ✅ | ✅ | | yaml | Enables support for Yaml from axum-yaml | ❌ | ✅ | ✅ | | extra | Enables support for Cached, WithRejection from axum-extra | ❌ | ✅ | ✅ | | extratypedpath | Enables support for T: TypedPath from axum-extra | ❌ | ✅ | ✅ | | extraquery | Enables support for Query from axum-extra | ❌ | ✅ | ✅ | | extraform | Enables support for Form from axum-extra | ❌ | ✅ | ✅ | | extraprotobuf | Enables support for Protobuf from axum-extra | ❌ | ✅ | ✅ | | allextratypes | Enables support for all extractors above from axum-extra | ❌ | ✅ | ✅ | | alltypes | Enables support for all extractors above | ❌ | ✅ | ✅ | | 422 | Use 422 Unprocessable Entity instead of 400 Bad Request as the status code when validation fails | ❌ | ✅ | ✅ | | into_json | Validation errors will be serialized into JSON format and returned as the HTTP body | ❌ | ✅ | ✅ | | full | Enables all features | ❌ | ✅ | ✅ |

axum-valid

Basic usage

[derive(Debug, Validate, Deserialize)]

[tokio::main]

Features

Compatibility

License

References