feat: add support with rocket_okapi and update crate dependencies

.github/workflows/build.yml

@@ -26,14 +26,14 @@ jobs:
     runs-on: ${{ matrix.config.node }}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4.1.1
+        uses: actions/checkout@v4.2.2
 
       - uses: actions-rs/toolchain@v1
         with:
           toolchain: ${{ matrix.toolchain }}
           override: true
 
-      - uses: Swatinem/rust-cache@v2.7.3
+      - uses: Swatinem/rust-cache@v2.7.5
 
       - name: Test Dev
         run: cargo test --all-features --workspace
@@ -89,7 +89,7 @@ jobs:
     runs-on: ${{ matrix.config.node }}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4.1.1
+        uses: actions/checkout@v4.2.2
 
       - uses: docker-practice/actions-setup-docker@master
 

.github/workflows/lint.yml

@@ -21,7 +21,7 @@ jobs:
         with:
           toolchain: stable
 
-      - uses: Swatinem/rust-cache@v2.7.3
+      - uses: Swatinem/rust-cache@v2.7.5
 
       - name: Run fmt
         run: cargo fmt -- --check
@@ -50,7 +50,7 @@ jobs:
           args: '-- --test-threads 1'
 
       - name: Upload to codecov.io
-        uses: codecov/codecov-action@v4.0.1
+        uses: codecov/codecov-action@v5.1.1
         with:
           token: ${{secrets.CODECOV_TOKEN}}
 

Cargo.toml

@@ -10,16 +10,23 @@ categories = ["web-programming"]
 rust-version = "1.59.0"
 description = "Rocket Guards to support validation using validator"
 
+[features]
+rocket_okapi = []
+parser_errors = []
+
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [lib]
 path = "src/lib.rs"
 
 [dependencies]
-rocket = { version = "0.5.0", default-features = false, features = [
+rocket = { version = "0.5.1", default-features = false, features = [
     "json",
+    "serde_json"
 ] }
-validator = { version = "0.18.0", features = ["derive"] }
+validator = { version = "0.19.0", features = ["derive"] }
+schemars = "0.8.21"
+rocket_okapi = "0.9.0"
 
 [[example]]
 name = "json-validation"

examples/form-validation/Cargo.toml

@@ -3,16 +3,13 @@ name = "form-validation"
 version = "0.1.0"
 edition = "2021"
 repository = "https://github.com/somehowchris/rocket-validation"
-keywords = ["me"]
-categories = ["me"]
 rust-version = "1.59.0"
 readme = "../.."
 license = "MIT"
-description = "me"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-rocket = { version = "0.5.0-rc.1", features=["json"] }
-rocket-validation = { path = "../../" }
-validator = "0.16.0"
+rocket = { version = "0.5.1", features=["json"] }
+rocket-validation = { path = "../.." }
+validator = "0.19.0"

examples/json-validation/Cargo.toml

@@ -3,16 +3,14 @@ name = "json-validation"
 version = "0.1.0"
 edition = "2021"
 repository = "https://github.com/somehowchris/rocket-validation"
-keywords = ["me"]
-categories = ["me"]
 rust-version = "1.59.0"
 readme = "../.."
 license = "MIT"
-description = "me"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-rocket = { version = "0.5.0-rc.1", features=["json"] }
-rocket-validation = { path = "../../" }
-validator = "0.16.0"
+rocket = { version = "0.5.1", features=["json"] }
+rocket-validation = { path = "../.." }
+validator = "0.19.0"
+

examples/query-validation/Cargo.toml

@@ -3,16 +3,13 @@ name = "query-validation"
 version = "0.1.0"
 edition = "2021"
 repository = "https://github.com/somehowchris/rocket-validation"
-keywords = ["me"]
-categories = ["me"]
 rust-version = "1.59.0"
 readme = "../.."
 license = "MIT"
-description = "me"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-rocket = { version = "0.5.0-rc.1", features=["json"] }
-rocket-validation = { path = "../../" }
-validator = "0.16.0"
+rocket = { version = "0.5.1", features=["json"] }
+rocket-validation = { path = "../.." }
+validator = "0.19.0"

src/lib.rs

@@ -82,6 +82,7 @@ pub extern crate validator;
 #[macro_use]
 extern crate rocket;
 
+use std::borrow::Cow;
 use rocket::{
     data::{Data, FromData, Outcome as DataOutcome},
     form,
@@ -92,7 +93,11 @@ use rocket::{
     serde::{json::Json, Serialize},
 };
 use std::fmt::Debug;
+use rocket::form::{Form, Options};
+use rocket_okapi::gen::OpenApiGenerator;
+use rocket_okapi::okapi::openapi3::Parameter;
 pub use validator::{Validate, ValidationErrors};
+use validator::ValidationError;
 
 ///  Struct used for Request Guards
 #[derive(Clone, Debug)]
@@ -184,7 +189,15 @@ impl<'r, D: Validate + rocket::serde::Deserialize<'r>> FromData<'r> for Validate
         let data_outcome = <Json<D> as FromData<'r>>::from_data(req, data).await;
 
         match data_outcome {
-            Outcome::Error((status, err)) => Outcome::Error((status, Err(err))),
+            Outcome::Error((status, err)) => {
+                let mut errors = ValidationErrors::new();
+
+                #[cfg(feature = "parser_errors")]
+                errors.add("Parser", ValidationError::new("Error").with_message(Cow::from(err.to_string())));
+
+                req.local_cache(|| CachedValidationErrors(Some(errors)));
+                Outcome::Error((status, Err(err)))
+            },
             Outcome::Forward(err) => Outcome::Forward(err),
             Outcome::Success(data) => match data.validate() {
                 Ok(_) => Outcome::Success(Validated(data)),
@@ -288,3 +301,63 @@ impl<'r, T: Validate + FromForm<'r>> FromForm<'r> for Validated<T> {
         }
     }
 }
+
+#[cfg(feature = "rocket_okapi")]
+#[rocket::async_trait]
+impl<T> rocket_okapi::request::OpenApiFromData<'_> for Validated<Json<T>>
+where
+    T: schemars::JsonSchema + for<'de> rocket::serde::Deserialize<'de> + validator::Validate,
+{
+    fn request_body(gen: &mut OpenApiGenerator) -> rocket_okapi::Result<rocket_okapi::okapi::openapi3::RequestBody> {
+        Json::<T>::request_body(gen)
+    }
+}
+
+#[cfg(feature = "rocket_okapi")]
+#[rocket::async_trait]
+impl<'r, T> FromData<'r> for Validated<Form<T>>
+where
+    T: FromForm<'r> + Validate,
+{
+    type Error = Result<ValidationErrors, form::Errors<'r>>;
+
+    async fn from_data(req: &'r Request<'_>, data: Data<'r>) -> DataOutcome<'r, Self> {
+        let data_outcome = <Form<T> as FromData<'r>>::from_data(req, data).await;
+
+        match data_outcome {
+            DataOutcome::Error((status, err)) => DataOutcome::Error((status, Err(err))),
+            DataOutcome::Forward(f) => DataOutcome::Forward(f),
+            DataOutcome::Success(form) => {
+                let inner = form.into_inner();
+                match inner.validate() {
+                    Ok(_) => DataOutcome::Success(Validated(rocket::form::Form::from(inner))),
+                    Err(err) => {
+                        req.local_cache(|| CachedValidationErrors(Some(err.to_owned())));
+                        DataOutcome::Error((Status::UnprocessableEntity, Ok(err)))
+                    }
+                }
+            }
+        }
+    }
+}
+
+#[cfg(feature = "rocket_okapi")]
+#[rocket::async_trait]
+impl<'r, T> rocket_okapi::request::OpenApiFromData<'r> for Validated<Form<T>>
+where
+    T: schemars::JsonSchema + FromForm<'r> + 'static + validator::Validate,
+{
+    fn request_body(gen: &mut OpenApiGenerator) -> rocket_okapi::Result<rocket_okapi::okapi::openapi3::RequestBody> {
+        Form::<T>::request_body(gen)
+    }
+}
+
+#[cfg(feature = "rocket_okapi")]
+impl<'r, T> rocket_okapi::request::OpenApiFromForm<'r> for Validated<T>
+where
+    T: schemars::JsonSchema + FromForm<'r> + 'static + validator::Validate,
+{
+    fn form_multi_parameter(gen: &mut OpenApiGenerator, name: String, required: bool) -> rocket_okapi::Result<Vec<Parameter>> {
+        T::form_multi_parameter(gen, name, required)
+    }
+}