[](https://crates.io/crates/vld-axum)
[](https://docs.rs/vld-axum)
[](https://github.com/s00d/vld/blob/main/LICENSE)
[](https://github.com/s00d/vld)
[](https://github.com/s00d/vld/issues)
[](https://github.com/s00d/vld/stargazers)
# vld-axum
[Axum](https://github.com/tokio-rs/axum) integration for the [vld](https://crates.io/crates/vld) validation library.
## Overview
Provides 6 extractors that validate request data using `vld` schemas **before** your handler runs:
| `VldJson<T>` | `axum::Json<T>` | JSON request body |
| `VldQuery<T>` | `axum::extract::Query<T>` | URL query parameters |
| `VldPath<T>` | `axum::extract::Path<T>` | URL path parameters |
| `VldForm<T>` | `axum::extract::Form<T>` | URL-encoded form body |
| `VldHeaders<T>` | manual header extraction | HTTP headers |
| `VldCookie<T>` | manual cookie parsing | Cookie values |
On validation failure all extractors return **422 Unprocessable Entity** with a JSON body describing every issue.
## Installation
```toml
[dependencies]
vld = "0.1"
vld-axum = "0.1"
axum = "0.8"
tokio = { version = "1", features = ["full"] }
```
## VldJson — JSON body
```rust
use axum::{Router, routing::post};
use vld_axum::VldJson;
vld::schema! {
#[derive(Debug)]
pub struct CreateUser {
pub name: String => vld::string().min(2).max(50),
pub email: String => vld::string().email(),
}
}
async fn create_user(VldJson(user): VldJson<CreateUser>) -> String {
format!("Created: {}", user.name)
}
```
## VldQuery — query parameters
Values are automatically coerced: `"42"` → number, `"true"`/`"false"` → boolean, empty → null.
```rust
use axum::{Router, routing::get};
use vld::prelude::*;
use vld_axum::VldQuery;
vld::schema! {
#[derive(Debug)]
pub struct SearchParams {
pub q: String => vld::string().min(1).max(200),
pub page: Option<i64> => vld::number().int().min(1).optional(),
pub limit: Option<i64> => vld::number().int().min(1).max(100).optional(),
}
}
async fn search(VldQuery(p): VldQuery<SearchParams>) -> String {
format!("Searching '{}' page={:?}", p.q, p.page)
}
```
## VldPath — path parameters
```rust
use axum::{Router, routing::get};
use vld_axum::VldPath;
vld::schema! {
#[derive(Debug)]
pub struct UserPath {
pub id: i64 => vld::number().int().min(1),
}
}
async fn get_user(VldPath(p): VldPath<UserPath>) -> String {
format!("User #{}", p.id)
}
let app = Router::new().route("/users/{id}", get(get_user));
```
## VldForm — URL-encoded form body
```rust
use axum::{Router, routing::post};
use vld_axum::VldForm;
vld::schema! {
#[derive(Debug)]
pub struct LoginForm {
pub username: String => vld::string().min(3).max(50),
pub password: String => vld::string().min(8),
}
}
async fn login(VldForm(f): VldForm<LoginForm>) -> String {
format!("Welcome, {}!", f.username)
}
```
## VldHeaders — HTTP headers
Header names are normalised to snake_case: `Content-Type` → `content_type`, `X-Request-Id` → `x_request_id`.
```rust
use axum::{Router, routing::get};
use vld::prelude::*;
use vld_axum::VldHeaders;
vld::schema! {
#[derive(Debug)]
pub struct AuthHeaders {
pub authorization: String => vld::string().min(1),
pub x_request_id: Option<String> => vld::string().optional(),
}
}
async fn protected(VldHeaders(h): VldHeaders<AuthHeaders>) -> String {
format!("auth={}", h.authorization)
}
```
## VldCookie — cookies
Cookie names are matched as-is to schema field names.
```rust
use axum::{Router, routing::get};
use vld::prelude::*;
use vld_axum::VldCookie;
vld::schema! {
#[derive(Debug)]
pub struct Session {
pub session_id: String => vld::string().min(1),
pub theme: Option<String> => vld::string().optional(),
}
}
async fn dashboard(VldCookie(c): VldCookie<Session>) -> String {
format!("session={}", c.session_id)
}
```
## Combining extractors
Multiple extractors can be used in the same handler:
```rust
use axum::{Router, routing::post};
use vld::prelude::*;
use vld_axum::{VldJson, VldQuery, VldHeaders};
vld::schema! {
#[derive(Debug)]
pub struct OrderQuery {
pub dry_run: Option<bool> => vld::boolean().optional(),
}
}
vld::schema! {
#[derive(Debug)]
pub struct OrderBody {
pub product_id: i64 => vld::number().int().min(1),
pub quantity: i64 => vld::number().int().min(1).max(1000),
}
}
async fn create_order(
VldQuery(q): VldQuery<OrderQuery>,
VldJson(b): VldJson<OrderBody>,
) -> String {
format!("product={} qty={} dry_run={:?}", b.product_id, b.quantity, q.dry_run)
}
```
## Running the example
```sh
cargo run -p vld-axum --example axum_basic
```
### Example requests
```sh
# VldJson — create user:
curl -s -X POST http://localhost:3000/users \
-H "Content-Type: application/json" \
# VldPath — get user by id:
# VldQuery — search:
# VldForm — login (URL-encoded):
curl -s -X POST http://localhost:3000/login \
# VldHeaders — protected endpoint:
curl -s http://localhost:3000/protected \
-H "Authorization: Bearer mytoken123" \
# VldCookie — dashboard:
curl -s http://localhost:3000/dashboard \
-b "session_id=s3ss10n; theme=dark" | jq
# Combined — query + body:
curl -s -X POST "http://localhost:3000/orders?dry_run=true¤cy=USD" \
-H "Content-Type: application/json" \
-d '{"product_id": 42, "quantity": 3}' | jq
```
## Error response format
```json
{
"error": "Validation failed",
"issues": [
{ "path": "name", "message": "String must contain at least 2 character(s)", "code": "too_small" }
]
}
```
## License
MIT