axum-valid

crates.io LICENSE dependency status GitHub Workflow Status Coverage Status

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.

Usage

shell cargo add axum-valid

```rust use validator::Validate; use serde::Deserialize; use axum_valid::Valid; use axum::extract::Query; use axum::Json;

[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 getpagebyquery( Valid(Query(pager)): Valid>, ) { assert!((1..=50).contains(&pager.pagesize)); assert!((1..).contains(&pager.page_no)); }

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

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

Features

| Feature | Description | Default | 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 | ❌ | ✅ | | 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 | ❌ | ✅ | | 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 | ❌ | ✅ | | intojson | Validation errors will be serialized into JSON format and returned as the HTTP body | ❌ | ✅ | | full | Enables all features | ❌ | ✅ |

License

This project is licensed under the MIT License.

References