vld-aide

aide / schemars integration for the vld validation library.

Overview

Bridge between vld validation schemas and aide OpenAPI documentation generator. Define your validation rules once in vld and get schemars::JsonSchema compatibility for free — no need to duplicate with #[derive(JsonSchema)].

aide uses schemars for JSON Schema generation. This crate converts vld's JSON Schema output to schemars::Schema, making your validated types usable with aide::axum::Json<T>, aide::axum::Query<T>, and other aide extractors.

Installation

[dependencies]
vld = { version = "0.1", features = ["openapi"] }
vld-aide = "0.1"
aide = { version = "0.15", features = ["axum"] }

Quick Start

impl_json_schema! macro

use vld::prelude::*;
use vld_aide::impl_json_schema;

vld::schema! {
    #[derive(Debug)]
    pub struct CreateUser {
        pub name: String => vld::string().min(2).max(100),
        pub email: String => vld::string().email(),
        pub age: i64 => vld::number().int().min(13).max(150),
    }
}

impl_json_schema!(CreateUser);

// Now `CreateUser` implements `schemars::JsonSchema`
// and works with aide for OpenAPI doc generation.

Custom schema name

impl_json_schema!(CreateUser, "CreateUserRequest");

With #[derive(Validate)]

use vld::Validate;
use vld_aide::impl_json_schema;

#[derive(Debug, serde::Deserialize, Validate)]
#[serde(rename_all = "camelCase")]
struct UpdateUser {
    #[vld(vld::string().min(1).max(255))]
    first_name: String,
    #[vld(vld::string().email())]
    email_address: String,
    #[vld(vld::boolean())]
    is_active: bool,
}

impl_json_schema!(UpdateUser);
// Schema properties will use camelCase: firstName, emailAddress, isActive

Usage with aide + axum

use aide::axum::{ApiRouter, routing::post_with};
use aide::axum::Json;
use aide::transform::TransformOperation;

async fn create_user(Json(body): Json<CreateUser>) -> Json<serde_json::Value> {
    Json(serde_json::json!({"id": 1, "name": body.name}))
}

fn create_user_docs(op: TransformOperation) -> TransformOperation {
    op.summary("Create a new user")
      .description("Validates name, email, and age constraints.")
}

let app = ApiRouter::new()
    .api_route("/users", post_with(create_user, create_user_docs));

Direct conversion

Convert any vld JSON schema value to schemars::Schema:

use vld_aide::vld_to_schemars;

let vld_schema = serde_json::json!({
    "type": "object",
    "required": ["name"],
    "properties": {
        "name": { "type": "string", "minLength": 1 }
    }
});

let schemars_schema = vld_to_schemars(&vld_schema);

API Reference

Comparison with vld-utoipa

Running the example

cargo run -p vld-aide --example aide_basic

License

MIT