#validation #serde #jsonschema #actix-web

actix-web-jsonschema

JsonSchema Validation Extractor for Actix Web

4 stable releases

1.1.0 Dec 1, 2022
1.0.2 Nov 10, 2022

#260 in HTTP server

44 downloads per month

MIT license

23KB
394 lines

actix-web-jsonschema

Latest Version Documentation GitHub license

This crate is a Rust library for providing validation mechanism to actix-web with jsonschema crate.

More information about this crate can be found in the crate documentation.

Installation

This crate works with Cargo and can be found on crates.io with a Cargo.toml like:

[dependencies]
actix-web = { version = "4", features = ["macros"] }
actix-web-jsonschema = { version = "1", features = ["validator"] }
serde = { version = "1", features = ["derive"] }
schemars = { version = "0.8" }
validator = { version = "0.16", features = ["derive"] }

Supported extractors

actix_web actix_web_jsonschema
actix_web::web::Path actix_web_jsonschema::Path
actix_web::web::Query actix_web_jsonschema::Query
actix_web::web::Form actix_web_jsonschema::Form
actix_web::web::Json actix_web_jsonschema::Json
serde_qs::actix::QsQuery actix_web_jsonschema::QsQuery

Example

use actix_web::{web, App};
use serde::Deserialize;
use schemars::JsonSchema;
use validator::Validate;
use actix_web_jsonschema::Query;

#[derive(Deserialize, JsonSchema, Validate)]
struct Request {
    #[validate(length(min = 1, max = 20))]
    name: String,
}

async fn index(Query(Request{ name }): Query<Request>) -> String {
    format!("Hello, {name}!")
}

fn main() {
    let app = App::new().service(
        web::resource("/hello").route(web::get().to(index))); // <- use `Query` extractor
}

License: MIT

Dependencies

~18–26MB
~585K SLoC