build(deps): update axum requirement from 0.6.x to 0.7.x
This commit is contained in:
36
Cargo.toml
36
Cargo.toml
@@ -1,6 +1,6 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "axum-valid"
|
name = "axum-valid"
|
||||||
version = "0.11.0"
|
version = "0.12.0-alpha"
|
||||||
description = "Provides validation extractors for your Axum application, allowing you to validate data using validator, garde, validify or all of them."
|
description = "Provides validation extractors for your Axum application, allowing you to validate data using validator, garde, validify or all of them."
|
||||||
authors = ["GengTeng <me@gteng.org>"]
|
authors = ["GengTeng <me@gteng.org>"]
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
@@ -25,38 +25,23 @@ edition = "2021"
|
|||||||
features = ["full"]
|
features = ["full"]
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
axum = { version = "0.6.20", default-features = false }
|
axum = { version = "0.7.1", default-features = false }
|
||||||
garde = { version = "0.16.0", optional = true }
|
garde = { version = "0.16.3", optional = true }
|
||||||
validator = { version = "0.16.1", optional = true}
|
validator = { version = "0.16.1", optional = true}
|
||||||
validify = { version = "1.0.12", optional = true }
|
validify = { version = "1.0.12", optional = true }
|
||||||
|
|
||||||
[dependencies.axum_typed_multipart]
|
|
||||||
version = "0.10.0"
|
|
||||||
default-features = false
|
|
||||||
optional = true
|
|
||||||
|
|
||||||
[dependencies.axum-msgpack]
|
|
||||||
version = "0.3.0"
|
|
||||||
default-features = false
|
|
||||||
optional = true
|
|
||||||
|
|
||||||
[dependencies.axum-yaml]
|
|
||||||
version = "0.3.0"
|
|
||||||
default-features = false
|
|
||||||
optional = true
|
|
||||||
|
|
||||||
[dependencies.axum-extra]
|
[dependencies.axum-extra]
|
||||||
version = "0.8.0"
|
version = "0.9.0"
|
||||||
default-features = false
|
default-features = false
|
||||||
optional = true
|
optional = true
|
||||||
|
|
||||||
[dependencies.serde]
|
[dependencies.serde]
|
||||||
version = "1.0.189"
|
version = "1.0.193"
|
||||||
optional = true
|
optional = true
|
||||||
|
|
||||||
[dev-dependencies]
|
[dev-dependencies]
|
||||||
anyhow = "1.0.72"
|
anyhow = "1.0.72"
|
||||||
axum = { version = "0.6.20", features = ["macros"] }
|
axum = { version = "0.7.1", features = ["macros"] }
|
||||||
tokio = { version = "1.33.0", features = ["full"] }
|
tokio = { version = "1.33.0", features = ["full"] }
|
||||||
hyper = { version = "0.14.27", features = ["full"] }
|
hyper = { version = "0.14.27", features = ["full"] }
|
||||||
reqwest = { version = "0.11.22", features = ["json", "multipart"] }
|
reqwest = { version = "0.11.22", features = ["json", "multipart"] }
|
||||||
@@ -78,10 +63,7 @@ validify = ["dep:validify"]
|
|||||||
json = ["axum/json"]
|
json = ["axum/json"]
|
||||||
form = ["axum/form"]
|
form = ["axum/form"]
|
||||||
query = ["axum/query"]
|
query = ["axum/query"]
|
||||||
typed_header = ["axum/headers"]
|
typed_header = ["extra", "axum-extra/typed-header"]
|
||||||
typed_multipart = ["dep:axum_typed_multipart"]
|
|
||||||
msgpack = ["dep:axum-msgpack"]
|
|
||||||
yaml = ["dep:axum-yaml"]
|
|
||||||
into_json = ["json", "dep:serde"]
|
into_json = ["json", "dep:serde"]
|
||||||
422 = []
|
422 = []
|
||||||
extra = ["dep:axum-extra"]
|
extra = ["dep:axum-extra"]
|
||||||
@@ -89,8 +71,8 @@ extra_typed_path = ["extra", "axum-extra/typed-routing"]
|
|||||||
extra_query = ["extra", "axum-extra/query"]
|
extra_query = ["extra", "axum-extra/query"]
|
||||||
extra_form = ["extra", "axum-extra/form"]
|
extra_form = ["extra", "axum-extra/form"]
|
||||||
extra_protobuf = ["extra", "axum-extra/protobuf"]
|
extra_protobuf = ["extra", "axum-extra/protobuf"]
|
||||||
all_extra_types = ["extra", "extra_typed_path", "extra_query", "extra_form", "extra_protobuf"]
|
all_extra_types = ["extra", "typed_header", "extra_typed_path", "extra_query", "extra_form", "extra_protobuf"]
|
||||||
all_types = ["json", "form", "query", "typed_header", "typed_multipart", "msgpack", "yaml", "all_extra_types"]
|
all_types = ["json", "form", "query", "all_extra_types"]
|
||||||
full_validator = ["validator", "all_types", "422", "into_json"]
|
full_validator = ["validator", "all_types", "422", "into_json"]
|
||||||
full_garde = ["garde", "all_types", "422", "into_json"]
|
full_garde = ["garde", "all_types", "422", "into_json"]
|
||||||
full_validify = ["validify", "all_types", "422", "into_json"]
|
full_validify = ["validify", "all_types", "422", "into_json"]
|
||||||
|
|||||||
111
README.md
111
README.md
@@ -9,6 +9,8 @@
|
|||||||
|
|
||||||
## 📑 Overview
|
## 📑 Overview
|
||||||
|
|
||||||
|
**Note: This is an alpha version. It currently supports extractors from Axum 0.7 and Axum-extra 0.9 only. Support for extractors from `axum-yaml`, `axum-msgpack`, and `axum_typed_multipart` will be provided once their dependencies are updated.**
|
||||||
|
|
||||||
**axum-valid** is a library that provides data validation extractors for the Axum web framework. It integrates **validator**, **garde** and **validify**, three popular validation crates in the Rust ecosystem, to offer convenient validation and data handling extractors for Axum applications.
|
**axum-valid** is a library that provides data validation extractors for the Axum web framework. It integrates **validator**, **garde** and **validify**, three popular validation crates in the Rust ecosystem, to offer convenient validation and data handling extractors for Axum applications.
|
||||||
|
|
||||||
## 🚀 Basic usage
|
## 🚀 Basic usage
|
||||||
@@ -26,12 +28,14 @@ cargo add axum-valid
|
|||||||
* Example
|
* Example
|
||||||
|
|
||||||
```rust,ignore
|
```rust,ignore
|
||||||
use validator::Validate;
|
|
||||||
use serde::Deserialize;
|
|
||||||
use axum_valid::Valid;
|
|
||||||
use axum::extract::Query;
|
use axum::extract::Query;
|
||||||
use axum::{Json, Router};
|
|
||||||
use axum::routing::{get, post};
|
use axum::routing::{get, post};
|
||||||
|
use axum::{Json, Router};
|
||||||
|
use axum_valid::Valid;
|
||||||
|
use serde::Deserialize;
|
||||||
|
use std::net::SocketAddr;
|
||||||
|
use tokio::net::TcpListener;
|
||||||
|
use validator::Validate;
|
||||||
|
|
||||||
#[derive(Debug, Validate, Deserialize)]
|
#[derive(Debug, Validate, Deserialize)]
|
||||||
pub struct Pager {
|
pub struct Pager {
|
||||||
@@ -41,16 +45,12 @@ pub struct Pager {
|
|||||||
pub page_no: usize,
|
pub page_no: usize,
|
||||||
}
|
}
|
||||||
|
|
||||||
pub async fn pager_from_query(
|
pub async fn pager_from_query(Valid(Query(pager)): Valid<Query<Pager>>) {
|
||||||
Valid(Query(pager)): Valid<Query<Pager>>,
|
|
||||||
) {
|
|
||||||
assert!((1..=50).contains(&pager.page_size));
|
assert!((1..=50).contains(&pager.page_size));
|
||||||
assert!((1..).contains(&pager.page_no));
|
assert!((1..).contains(&pager.page_no));
|
||||||
}
|
}
|
||||||
|
|
||||||
pub async fn pager_from_json(
|
pub async fn pager_from_json(pager: Valid<Json<Pager>>) {
|
||||||
pager: Valid<Json<Pager>>,
|
|
||||||
) {
|
|
||||||
assert!((1..=50).contains(&pager.page_size));
|
assert!((1..=50).contains(&pager.page_size));
|
||||||
assert!((1..).contains(&pager.page_no));
|
assert!((1..).contains(&pager.page_no));
|
||||||
// NOTE: all extractors provided support automatic dereferencing
|
// NOTE: all extractors provided support automatic dereferencing
|
||||||
@@ -62,9 +62,8 @@ async fn main() -> anyhow::Result<()> {
|
|||||||
let router = Router::new()
|
let router = Router::new()
|
||||||
.route("/query", get(pager_from_query))
|
.route("/query", get(pager_from_query))
|
||||||
.route("/json", post(pager_from_json));
|
.route("/json", post(pager_from_json));
|
||||||
axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
.serve(router.into_make_service())
|
axum::serve(listener, router.into_make_service()).await?;
|
||||||
.await?;
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -90,6 +89,8 @@ use axum::{Json, Router};
|
|||||||
use axum_valid::Garde;
|
use axum_valid::Garde;
|
||||||
use garde::Validate;
|
use garde::Validate;
|
||||||
use serde::Deserialize;
|
use serde::Deserialize;
|
||||||
|
use std::net::SocketAddr;
|
||||||
|
use tokio::net::TcpListener;
|
||||||
|
|
||||||
#[derive(Debug, Validate, Deserialize)]
|
#[derive(Debug, Validate, Deserialize)]
|
||||||
pub struct Pager {
|
pub struct Pager {
|
||||||
@@ -132,12 +133,10 @@ async fn main() -> anyhow::Result<()> {
|
|||||||
state_field: 1,
|
state_field: 1,
|
||||||
without_validation_arguments: (),
|
without_validation_arguments: (),
|
||||||
});
|
});
|
||||||
axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
.serve(router.into_make_service())
|
axum::serve(listener, router.into_make_service()).await?;
|
||||||
.await?;
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### 📦 `Validated<E>`, `Modified<E>`, `Validified<E>` and `ValidifiedByRef<E>`
|
### 📦 `Validated<E>`, `Modified<E>`, `Validified<E>` and `ValidifiedByRef<E>`
|
||||||
@@ -162,9 +161,10 @@ cargo add axum-valid --features validify,basic,typed_multipart --no-default-feat
|
|||||||
use axum::extract::Query;
|
use axum::extract::Query;
|
||||||
use axum::routing::{get, post};
|
use axum::routing::{get, post};
|
||||||
use axum::{Form, Json, Router};
|
use axum::{Form, Json, Router};
|
||||||
use axum_typed_multipart::{TryFromMultipart, TypedMultipart};
|
|
||||||
use axum_valid::{Modified, Validated, Validified, ValidifiedByRef};
|
use axum_valid::{Modified, Validated, Validified, ValidifiedByRef};
|
||||||
use serde::Deserialize;
|
use serde::Deserialize;
|
||||||
|
use std::net::SocketAddr;
|
||||||
|
use tokio::net::TcpListener;
|
||||||
use validify::{Validate, Validify};
|
use validify::{Validate, Validify};
|
||||||
|
|
||||||
#[derive(Debug, Validify, Deserialize)]
|
#[derive(Debug, Validify, Deserialize)]
|
||||||
@@ -206,25 +206,32 @@ pub async fn parameters_from_form(parameters: Validified<Form<Parameters>>) {
|
|||||||
assert!(parameters.validate().is_ok());
|
assert!(parameters.validate().is_ok());
|
||||||
}
|
}
|
||||||
|
|
||||||
// NOTE: TypedMultipart doesn't using serde::Deserialize to construct data
|
pub async fn parameters_from_form_by_ref(parameters: ValidifiedByRef<Form<Parameters>>) {
|
||||||
// we should use ValidifiedByRef instead of Validified
|
assert_eq!(parameters.v0, parameters.v0.to_lowercase());
|
||||||
#[derive(Debug, Validify, TryFromMultipart)]
|
assert_eq!(parameters.v1, parameters.v1.trim());
|
||||||
pub struct FormData {
|
assert!(parameters.validate().is_ok());
|
||||||
#[modify(lowercase)]
|
|
||||||
#[validate(length(min = 1, max = 50))]
|
|
||||||
pub v0: String,
|
|
||||||
#[modify(trim)]
|
|
||||||
#[validate(length(min = 1, max = 100))]
|
|
||||||
pub v1: String,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub async fn parameters_from_typed_multipart(
|
// WARN: TypedMultipart will be supported in the stable release.
|
||||||
ValidifiedByRef(TypedMultipart(data)): ValidifiedByRef<TypedMultipart<FormData>>,
|
// NOTE: TypedMultipart doesn't using serde::Deserialize to construct data
|
||||||
) {
|
// we should use ValidifiedByRef instead of Validified
|
||||||
assert_eq!(data.v0, data.v0.to_lowercase());
|
// #[derive(Debug, Validify, TryFromMultipart)]
|
||||||
assert_eq!(data.v1, data.v1.trim());
|
// pub struct FormData {
|
||||||
assert!(data.validate().is_ok());
|
// #[modify(lowercase)]
|
||||||
}
|
// #[validate(length(min = 1, max = 50))]
|
||||||
|
// pub v0: String,
|
||||||
|
// #[modify(trim)]
|
||||||
|
// #[validate(length(min = 1, max = 100))]
|
||||||
|
// pub v1: String,
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// pub async fn parameters_from_typed_multipart(
|
||||||
|
// ValidifiedByRef(TypedMultipart(data)): ValidifiedByRef<TypedMultipart<FormData>>,
|
||||||
|
// ) {
|
||||||
|
// assert_eq!(data.v0, data.v0.to_lowercase());
|
||||||
|
// assert_eq!(data.v1, data.v1.trim());
|
||||||
|
// assert!(data.validate().is_ok());
|
||||||
|
// }
|
||||||
|
|
||||||
#[tokio::main]
|
#[tokio::main]
|
||||||
async fn main() -> anyhow::Result<()> {
|
async fn main() -> anyhow::Result<()> {
|
||||||
@@ -232,10 +239,10 @@ async fn main() -> anyhow::Result<()> {
|
|||||||
.route("/validated", get(pager_from_query))
|
.route("/validated", get(pager_from_query))
|
||||||
.route("/modified", post(parameters_from_json))
|
.route("/modified", post(parameters_from_json))
|
||||||
.route("/validified", post(parameters_from_form))
|
.route("/validified", post(parameters_from_form))
|
||||||
.route("/validified_by_ref", post(parameters_from_typed_multipart));
|
.route("/validified_by_ref", post(parameters_from_form_by_ref));
|
||||||
axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
// .route("/validified_by_ref", post(parameters_from_typed_multipart));
|
||||||
.serve(router.into_make_service())
|
let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
.await?;
|
axum::serve(listener, router.into_make_service()).await?;
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -261,7 +268,9 @@ use axum::routing::post;
|
|||||||
use axum::{Form, Router};
|
use axum::{Form, Router};
|
||||||
use axum_valid::{Arguments, ValidEx};
|
use axum_valid::{Arguments, ValidEx};
|
||||||
use serde::Deserialize;
|
use serde::Deserialize;
|
||||||
|
use std::net::SocketAddr;
|
||||||
use std::ops::{RangeFrom, RangeInclusive};
|
use std::ops::{RangeFrom, RangeInclusive};
|
||||||
|
use tokio::net::TcpListener;
|
||||||
use validator::{Validate, ValidateArgs, ValidationError};
|
use validator::{Validate, ValidateArgs, ValidationError};
|
||||||
|
|
||||||
// NOTE: When some fields use custom validation functions with arguments,
|
// NOTE: When some fields use custom validation functions with arguments,
|
||||||
@@ -324,12 +333,10 @@ async fn main() -> anyhow::Result<()> {
|
|||||||
// NOTE: The PagerValidArgs can also be stored in a XxxState,
|
// NOTE: The PagerValidArgs can also be stored in a XxxState,
|
||||||
// make sure it implements FromRef<XxxState>.
|
// make sure it implements FromRef<XxxState>.
|
||||||
|
|
||||||
axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
.serve(router.into_make_service())
|
axum::serve(listener, router.into_make_service()).await?;
|
||||||
.await?;
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### 📦 `Garde<E>`
|
### 📦 `Garde<E>`
|
||||||
@@ -337,9 +344,9 @@ async fn main() -> anyhow::Result<()> {
|
|||||||
* Install
|
* Install
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
cargo add validator --features derive
|
cargo add garde
|
||||||
cargo add axum-valid
|
cargo add axum-valid --features garde,basic --no-default-features
|
||||||
# validator is enabled by default
|
# excluding validator
|
||||||
```
|
```
|
||||||
|
|
||||||
* Example
|
* Example
|
||||||
@@ -350,7 +357,9 @@ use axum::{Form, Router};
|
|||||||
use axum_valid::Garde;
|
use axum_valid::Garde;
|
||||||
use garde::Validate;
|
use garde::Validate;
|
||||||
use serde::Deserialize;
|
use serde::Deserialize;
|
||||||
|
use std::net::SocketAddr;
|
||||||
use std::ops::{RangeFrom, RangeInclusive};
|
use std::ops::{RangeFrom, RangeInclusive};
|
||||||
|
use tokio::net::TcpListener;
|
||||||
|
|
||||||
#[derive(Debug, Validate, Deserialize)]
|
#[derive(Debug, Validate, Deserialize)]
|
||||||
#[garde(context(PagerValidContext))]
|
#[garde(context(PagerValidContext))]
|
||||||
@@ -397,9 +406,8 @@ async fn main() -> anyhow::Result<()> {
|
|||||||
// NOTE: The PagerValidContext can also be stored in a XxxState,
|
// NOTE: The PagerValidContext can also be stored in a XxxState,
|
||||||
// make sure it implements FromRef<XxxState>.
|
// make sure it implements FromRef<XxxState>.
|
||||||
// Consider using Arc to reduce deep copying costs.
|
// Consider using Arc to reduce deep copying costs.
|
||||||
axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
.serve(router.into_make_service())
|
axum::serve(listener, router.into_make_service()).await?;
|
||||||
.await?;
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -431,10 +439,7 @@ Current module documentation predominantly showcases `Valid` examples, the usage
|
|||||||
| json | Enables support for `Json` | [`json`] | ✅ | ✅ | ✅ |
|
| json | Enables support for `Json` | [`json`] | ✅ | ✅ | ✅ |
|
||||||
| query | Enables support for `Query` | [`query`] | ✅ | ✅ | ✅ |
|
| query | Enables support for `Query` | [`query`] | ✅ | ✅ | ✅ |
|
||||||
| form | Enables support for `Form` | [`form`] | ✅ | ✅ | ✅ |
|
| form | Enables support for `Form` | [`form`] | ✅ | ✅ | ✅ |
|
||||||
| typed_header | Enables support for `TypedHeader` | [`typed_header`] | ❌ | ✅ | ✅ |
|
| typed_header | Enables support for `TypedHeader` from `axum-extra` | [`typed_header`] | ❌ | ✅ | ✅ |
|
||||||
| typed_multipart | Enables support for `TypedMultipart` and `BaseMultipart` from `axum_typed_multipart` | [`typed_multipart`] | ❌ | ✅ | ✅ |
|
|
||||||
| msgpack | Enables support for `MsgPack` and `MsgPackRaw` from `axum-msgpack` | [`msgpack`] | ❌ | ✅ | ✅ |
|
|
||||||
| yaml | Enables support for `Yaml` from `axum-yaml` | [`yaml`] | ❌ | ✅ | ✅ |
|
|
||||||
| extra | Enables support for `Cached`, `WithRejection` from `axum-extra` | [`extra`] | ❌ | ✅ | ✅ |
|
| extra | Enables support for `Cached`, `WithRejection` from `axum-extra` | [`extra`] | ❌ | ✅ | ✅ |
|
||||||
| extra_typed_path | Enables support for `T: TypedPath` from `axum-extra` | [`extra::typed_path`] | ❌ | ✅ | ✅ |
|
| extra_typed_path | Enables support for `T: TypedPath` from `axum-extra` | [`extra::typed_path`] | ❌ | ✅ | ✅ |
|
||||||
| extra_query | Enables support for `Query` from `axum-extra` | [`extra::query`] | ❌ | ✅ | ✅ |
|
| extra_query | Enables support for `Query` from `axum-extra` | [`extra::query`] | ❌ | ✅ | ✅ |
|
||||||
|
|||||||
12
src/extra.rs
12
src/extra.rs
@@ -123,14 +123,16 @@
|
|||||||
//!
|
//!
|
||||||
//! # #[tokio::main]
|
//! # #[tokio::main]
|
||||||
//! # async fn main() -> anyhow::Result<()> {
|
//! # async fn main() -> anyhow::Result<()> {
|
||||||
|
//! # use std::net::SocketAddr;
|
||||||
//! # use axum::Router;
|
//! # use axum::Router;
|
||||||
|
//! # use tokio::net::TcpListener;
|
||||||
//! # let router = Router::new();
|
//! # let router = Router::new();
|
||||||
//! # #[cfg(feature = "validator")]
|
//! # #[cfg(feature = "validator")]
|
||||||
//! # let router = router.nest("/validator", validator_example::router());
|
//! # let router = router.nest("/validator", validator_example::router());
|
||||||
//! # #[cfg(feature = "garde")]
|
//! # #[cfg(feature = "garde")]
|
||||||
//! # let router = router.nest("/garde", garde_example::router());
|
//! # let router = router.nest("/garde", garde_example::router());
|
||||||
//! # axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
//! # let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
//! # .serve(router.into_make_service())
|
//! # axum::serve(listener, router.into_make_service())
|
||||||
//! # .await?;
|
//! # .await?;
|
||||||
//! # Ok(())
|
//! # Ok(())
|
||||||
//! # }
|
//! # }
|
||||||
@@ -255,14 +257,16 @@
|
|||||||
//!
|
//!
|
||||||
//! # #[tokio::main]
|
//! # #[tokio::main]
|
||||||
//! # async fn main() -> anyhow::Result<()> {
|
//! # async fn main() -> anyhow::Result<()> {
|
||||||
|
//! # use std::net::SocketAddr;
|
||||||
//! # use axum::Router;
|
//! # use axum::Router;
|
||||||
|
//! # use tokio::net::TcpListener;
|
||||||
//! # let router = Router::new();
|
//! # let router = Router::new();
|
||||||
//! # #[cfg(feature = "validator")]
|
//! # #[cfg(feature = "validator")]
|
||||||
//! # let router = router.nest("/validator", validator_example::router());
|
//! # let router = router.nest("/validator", validator_example::router());
|
||||||
//! # #[cfg(feature = "garde")]
|
//! # #[cfg(feature = "garde")]
|
||||||
//! # let router = router.nest("/garde", garde_example::router());
|
//! # let router = router.nest("/garde", garde_example::router());
|
||||||
//! # axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
//! # let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
//! # .serve(router.into_make_service())
|
//! # axum::serve(listener, router.into_make_service())
|
||||||
//! # .await?;
|
//! # .await?;
|
||||||
//! # Ok(())
|
//! # Ok(())
|
||||||
//! # }
|
//! # }
|
||||||
|
|||||||
@@ -70,14 +70,16 @@
|
|||||||
//!
|
//!
|
||||||
//! # #[tokio::main]
|
//! # #[tokio::main]
|
||||||
//! # async fn main() -> anyhow::Result<()> {
|
//! # async fn main() -> anyhow::Result<()> {
|
||||||
|
//! # use std::net::SocketAddr;
|
||||||
//! # use axum::Router;
|
//! # use axum::Router;
|
||||||
|
//! # use tokio::net::TcpListener;
|
||||||
//! # let router = Router::new();
|
//! # let router = Router::new();
|
||||||
//! # #[cfg(feature = "validator")]
|
//! # #[cfg(feature = "validator")]
|
||||||
//! # let router = router.nest("/validator", validator_example::router());
|
//! # let router = router.nest("/validator", validator_example::router());
|
||||||
//! # #[cfg(feature = "garde")]
|
//! # #[cfg(feature = "garde")]
|
||||||
//! # let router = router.nest("/garde", garde_example::router());
|
//! # let router = router.nest("/garde", garde_example::router());
|
||||||
//! # axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
//! # let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
//! # .serve(router.into_make_service())
|
//! # axum::serve(listener, router.into_make_service())
|
||||||
//! # .await?;
|
//! # .await?;
|
||||||
//! # Ok(())
|
//! # Ok(())
|
||||||
//! # }
|
//! # }
|
||||||
@@ -135,8 +137,9 @@ impl<T: validify::Validify> crate::HasValidify for Form<T> {
|
|||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use crate::tests::{ValidTest, ValidTestParameter};
|
use crate::tests::{ValidTest, ValidTestParameter};
|
||||||
|
use axum::http::StatusCode;
|
||||||
use axum_extra::extract::Form;
|
use axum_extra::extract::Form;
|
||||||
use reqwest::{RequestBuilder, StatusCode};
|
use reqwest::RequestBuilder;
|
||||||
use serde::Serialize;
|
use serde::Serialize;
|
||||||
|
|
||||||
impl<T: ValidTestParameter + Serialize> ValidTest for Form<T> {
|
impl<T: ValidTestParameter + Serialize> ValidTest for Form<T> {
|
||||||
|
|||||||
@@ -74,14 +74,16 @@
|
|||||||
//!
|
//!
|
||||||
//! # #[tokio::main]
|
//! # #[tokio::main]
|
||||||
//! # async fn main() -> anyhow::Result<()> {
|
//! # async fn main() -> anyhow::Result<()> {
|
||||||
|
//! # use std::net::SocketAddr;
|
||||||
//! # use axum::Router;
|
//! # use axum::Router;
|
||||||
|
//! # use tokio::net::TcpListener;
|
||||||
//! # let router = Router::new();
|
//! # let router = Router::new();
|
||||||
//! # #[cfg(feature = "validator")]
|
//! # #[cfg(feature = "validator")]
|
||||||
//! # let router = router.nest("/validator", validator_example::router());
|
//! # let router = router.nest("/validator", validator_example::router());
|
||||||
//! # #[cfg(feature = "garde")]
|
//! # #[cfg(feature = "garde")]
|
||||||
//! # let router = router.nest("/garde", garde_example::router());
|
//! # let router = router.nest("/garde", garde_example::router());
|
||||||
//! # axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
//! # let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
//! # .serve(router.into_make_service())
|
//! # axum::serve(listener, router.into_make_service())
|
||||||
//! # .await?;
|
//! # .await?;
|
||||||
//! # Ok(())
|
//! # Ok(())
|
||||||
//! # }
|
//! # }
|
||||||
|
|||||||
@@ -70,14 +70,16 @@
|
|||||||
//!
|
//!
|
||||||
//! # #[tokio::main]
|
//! # #[tokio::main]
|
||||||
//! # async fn main() -> anyhow::Result<()> {
|
//! # async fn main() -> anyhow::Result<()> {
|
||||||
|
//! # use std::net::SocketAddr;
|
||||||
//! # use axum::Router;
|
//! # use axum::Router;
|
||||||
|
//! # use tokio::net::TcpListener;
|
||||||
//! # let router = Router::new();
|
//! # let router = Router::new();
|
||||||
//! # #[cfg(feature = "validator")]
|
//! # #[cfg(feature = "validator")]
|
||||||
//! # let router = router.nest("/validator", validator_example::router());
|
//! # let router = router.nest("/validator", validator_example::router());
|
||||||
//! # #[cfg(feature = "garde")]
|
//! # #[cfg(feature = "garde")]
|
||||||
//! # let router = router.nest("/garde", garde_example::router());
|
//! # let router = router.nest("/garde", garde_example::router());
|
||||||
//! # axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
//! # let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
//! # .serve(router.into_make_service())
|
//! # axum::serve(listener, router.into_make_service())
|
||||||
//! # .await?;
|
//! # .await?;
|
||||||
//! # Ok(())
|
//! # Ok(())
|
||||||
//! # }
|
//! # }
|
||||||
|
|||||||
@@ -82,14 +82,16 @@
|
|||||||
//!
|
//!
|
||||||
//! # #[tokio::main]
|
//! # #[tokio::main]
|
||||||
//! # async fn main() -> anyhow::Result<()> {
|
//! # async fn main() -> anyhow::Result<()> {
|
||||||
|
//! # use std::net::SocketAddr;
|
||||||
//! # use axum::Router;
|
//! # use axum::Router;
|
||||||
|
//! # use tokio::net::TcpListener;
|
||||||
//! # let router = Router::new();
|
//! # let router = Router::new();
|
||||||
//! # #[cfg(feature = "validator")]
|
//! # #[cfg(feature = "validator")]
|
||||||
//! # let router = router.nest("/validator", validator_example::router());
|
//! # let router = router.nest("/validator", validator_example::router());
|
||||||
//! # #[cfg(feature = "garde")]
|
//! # #[cfg(feature = "garde")]
|
||||||
//! # let router = router.nest("/garde", garde_example::router());
|
//! # let router = router.nest("/garde", garde_example::router());
|
||||||
//! # axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
//! # let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
//! # .serve(router.into_make_service())
|
//! # axum::serve(listener, router.into_make_service())
|
||||||
//! # .await?;
|
//! # .await?;
|
||||||
//! # Ok(())
|
//! # Ok(())
|
||||||
//! # }
|
//! # }
|
||||||
|
|||||||
@@ -70,14 +70,16 @@
|
|||||||
//!
|
//!
|
||||||
//! # #[tokio::main]
|
//! # #[tokio::main]
|
||||||
//! # async fn main() -> anyhow::Result<()> {
|
//! # async fn main() -> anyhow::Result<()> {
|
||||||
|
//! # use std::net::SocketAddr;
|
||||||
//! # use axum::Router;
|
//! # use axum::Router;
|
||||||
|
//! # use tokio::net::TcpListener;
|
||||||
//! # let router = Router::new();
|
//! # let router = Router::new();
|
||||||
//! # #[cfg(feature = "validator")]
|
//! # #[cfg(feature = "validator")]
|
||||||
//! # let router = router.nest("/validator", validator_example::router());
|
//! # let router = router.nest("/validator", validator_example::router());
|
||||||
//! # #[cfg(feature = "garde")]
|
//! # #[cfg(feature = "garde")]
|
||||||
//! # let router = router.nest("/garde", garde_example::router());
|
//! # let router = router.nest("/garde", garde_example::router());
|
||||||
//! # axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
//! # let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
//! # .serve(router.into_make_service())
|
//! # axum::serve(listener, router.into_make_service())
|
||||||
//! # .await?;
|
//! # .await?;
|
||||||
//! # Ok(())
|
//! # Ok(())
|
||||||
//! # }
|
//! # }
|
||||||
|
|||||||
12
src/garde.rs
12
src/garde.rs
@@ -10,9 +10,8 @@ pub mod test;
|
|||||||
|
|
||||||
use crate::{HasValidate, ValidationRejection};
|
use crate::{HasValidate, ValidationRejection};
|
||||||
use axum::async_trait;
|
use axum::async_trait;
|
||||||
use axum::extract::{FromRef, FromRequest, FromRequestParts};
|
use axum::extract::{FromRef, FromRequest, FromRequestParts, Request};
|
||||||
use axum::http::request::Parts;
|
use axum::http::request::Parts;
|
||||||
use axum::http::Request;
|
|
||||||
use garde::{Report, Validate};
|
use garde::{Report, Validate};
|
||||||
use std::fmt::{Display, Formatter};
|
use std::fmt::{Display, Formatter};
|
||||||
use std::ops::{Deref, DerefMut};
|
use std::ops::{Deref, DerefMut};
|
||||||
@@ -69,17 +68,16 @@ impl<E> From<Report> for GardeRejection<E> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[async_trait]
|
#[async_trait]
|
||||||
impl<State, Body, Extractor, Context> FromRequest<State, Body> for Garde<Extractor>
|
impl<State, Extractor, Context> FromRequest<State> for Garde<Extractor>
|
||||||
where
|
where
|
||||||
State: Send + Sync,
|
State: Send + Sync,
|
||||||
Body: Send + Sync + 'static,
|
|
||||||
Context: Send + Sync + FromRef<State>,
|
Context: Send + Sync + FromRef<State>,
|
||||||
Extractor: HasValidate + FromRequest<State, Body>,
|
Extractor: HasValidate + FromRequest<State>,
|
||||||
<Extractor as HasValidate>::Validate: garde::Validate<Context = Context>,
|
<Extractor as HasValidate>::Validate: garde::Validate<Context = Context>,
|
||||||
{
|
{
|
||||||
type Rejection = GardeRejection<<Extractor as FromRequest<State, Body>>::Rejection>;
|
type Rejection = GardeRejection<<Extractor as FromRequest<State>>::Rejection>;
|
||||||
|
|
||||||
async fn from_request(req: Request<Body>, state: &State) -> Result<Self, Self::Rejection> {
|
async fn from_request(req: Request, state: &State) -> Result<Self, Self::Rejection> {
|
||||||
let context: Context = FromRef::from_ref(state);
|
let context: Context = FromRef::from_ref(state);
|
||||||
let inner = Extractor::from_request(req, state)
|
let inner = Extractor::from_request(req, state)
|
||||||
.await
|
.await
|
||||||
|
|||||||
@@ -3,16 +3,18 @@
|
|||||||
use crate::tests::{ValidTest, ValidTestParameter};
|
use crate::tests::{ValidTest, ValidTestParameter};
|
||||||
use crate::{Garde, HasValidate, VALIDATION_ERROR_STATUS};
|
use crate::{Garde, HasValidate, VALIDATION_ERROR_STATUS};
|
||||||
use axum::extract::{FromRef, Path, Query};
|
use axum::extract::{FromRef, Path, Query};
|
||||||
|
use axum::http::StatusCode;
|
||||||
use axum::routing::{get, post};
|
use axum::routing::{get, post};
|
||||||
use axum::{Form, Json, Router};
|
use axum::{Form, Json, Router};
|
||||||
use garde::Validate;
|
use garde::Validate;
|
||||||
use hyper::Method;
|
use hyper::Method;
|
||||||
use once_cell::sync::Lazy;
|
use once_cell::sync::Lazy;
|
||||||
use reqwest::{StatusCode, Url};
|
use reqwest::Url;
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
use std::any::type_name;
|
use std::any::type_name;
|
||||||
use std::net::SocketAddr;
|
use std::net::SocketAddr;
|
||||||
use std::ops::Deref;
|
use std::ops::Deref;
|
||||||
|
use tokio::net::TcpListener;
|
||||||
|
|
||||||
#[derive(Clone, Deserialize, Serialize, Validate, Eq, PartialEq)]
|
#[derive(Clone, Deserialize, Serialize, Validate, Eq, PartialEq)]
|
||||||
#[cfg_attr(feature = "extra_protobuf", derive(prost::Message))]
|
#[cfg_attr(feature = "extra_protobuf", derive(prost::Message))]
|
||||||
@@ -140,15 +142,14 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
|
|
||||||
let router = router.with_state(MyState::default());
|
let router = router.with_state(MyState::default());
|
||||||
|
|
||||||
let server = axum::Server::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16)))
|
let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
.serve(router.into_make_service());
|
let server_addr = listener.local_addr()?;
|
||||||
let server_addr = server.local_addr();
|
let server = axum::serve(listener, router.into_make_service());
|
||||||
println!("Axum server address: {}.", server_addr);
|
println!("Axum server address: {}.", server_addr);
|
||||||
|
|
||||||
let (server_guard, close) = tokio::sync::oneshot::channel::<()>();
|
tokio::spawn(async move {
|
||||||
let server_handle = tokio::spawn(server.with_graceful_shutdown(async move {
|
let _ = server.await;
|
||||||
let _ = close.await;
|
});
|
||||||
}));
|
|
||||||
|
|
||||||
let server_url = format!("http://{}", server_addr);
|
let server_url = format!("http://{}", server_addr);
|
||||||
let test_executor = TestExecutor::from(Url::parse(&format!("http://{}", server_addr))?);
|
let test_executor = TestExecutor::from(Url::parse(&format!("http://{}", server_addr))?);
|
||||||
@@ -168,8 +169,8 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
valid_path_response.status(),
|
valid_path_response.status().as_u16(),
|
||||||
StatusCode::OK,
|
StatusCode::OK.as_u16(),
|
||||||
"Valid '{}' test failed.",
|
"Valid '{}' test failed.",
|
||||||
path_type_name
|
path_type_name
|
||||||
);
|
);
|
||||||
@@ -180,8 +181,8 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
error_path_response.status(),
|
error_path_response.status().as_u16(),
|
||||||
StatusCode::BAD_REQUEST,
|
StatusCode::BAD_REQUEST.as_u16(),
|
||||||
"Error '{}' test failed.",
|
"Error '{}' test failed.",
|
||||||
path_type_name
|
path_type_name
|
||||||
);
|
);
|
||||||
@@ -195,8 +196,8 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
invalid_path_response.status(),
|
invalid_path_response.status().as_u16(),
|
||||||
VALIDATION_ERROR_STATUS,
|
VALIDATION_ERROR_STATUS.as_u16(),
|
||||||
"Invalid '{}' test failed.",
|
"Invalid '{}' test failed.",
|
||||||
path_type_name
|
path_type_name
|
||||||
);
|
);
|
||||||
@@ -225,7 +226,7 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
|
|
||||||
#[cfg(feature = "typed_header")]
|
#[cfg(feature = "typed_header")]
|
||||||
{
|
{
|
||||||
use axum::TypedHeader;
|
use axum_extra::typed_header::TypedHeader;
|
||||||
// Garde
|
// Garde
|
||||||
test_executor
|
test_executor
|
||||||
.execute::<TypedHeader<ParametersGarde>>(
|
.execute::<TypedHeader<ParametersGarde>>(
|
||||||
@@ -296,8 +297,8 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
valid_extra_typed_path_response.status(),
|
valid_extra_typed_path_response.status().as_u16(),
|
||||||
StatusCode::OK,
|
StatusCode::OK.as_u16(),
|
||||||
"Garde '{}' test failed.",
|
"Garde '{}' test failed.",
|
||||||
extra_typed_path_type_name
|
extra_typed_path_type_name
|
||||||
);
|
);
|
||||||
@@ -308,8 +309,8 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
error_extra_typed_path_response.status(),
|
error_extra_typed_path_response.status().as_u16(),
|
||||||
StatusCode::BAD_REQUEST,
|
StatusCode::BAD_REQUEST.as_u16(),
|
||||||
"Error '{}' test failed.",
|
"Error '{}' test failed.",
|
||||||
extra_typed_path_type_name
|
extra_typed_path_type_name
|
||||||
);
|
);
|
||||||
@@ -323,8 +324,8 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
invalid_extra_typed_path_response.status(),
|
invalid_extra_typed_path_response.status().as_u16(),
|
||||||
VALIDATION_ERROR_STATUS,
|
VALIDATION_ERROR_STATUS.as_u16(),
|
||||||
"Invalid '{}' test failed.",
|
"Invalid '{}' test failed.",
|
||||||
extra_typed_path_type_name
|
extra_typed_path_type_name
|
||||||
);
|
);
|
||||||
@@ -387,8 +388,6 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.await?;
|
.await?;
|
||||||
}
|
}
|
||||||
|
|
||||||
drop(server_guard);
|
|
||||||
server_handle.await??;
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -421,8 +420,8 @@ impl TestExecutor {
|
|||||||
let valid_builder = self.client.request(method.clone(), url.clone());
|
let valid_builder = self.client.request(method.clone(), url.clone());
|
||||||
let valid_response = T::set_valid_request(valid_builder).send().await?;
|
let valid_response = T::set_valid_request(valid_builder).send().await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
valid_response.status(),
|
valid_response.status().as_u16(),
|
||||||
StatusCode::OK,
|
StatusCode::OK.as_u16(),
|
||||||
"Garde '{}' test failed.",
|
"Garde '{}' test failed.",
|
||||||
type_name
|
type_name
|
||||||
);
|
);
|
||||||
@@ -430,8 +429,8 @@ impl TestExecutor {
|
|||||||
let error_builder = self.client.request(method.clone(), url.clone());
|
let error_builder = self.client.request(method.clone(), url.clone());
|
||||||
let error_response = T::set_error_request(error_builder).send().await?;
|
let error_response = T::set_error_request(error_builder).send().await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
error_response.status(),
|
error_response.status().as_u16(),
|
||||||
T::ERROR_STATUS_CODE,
|
T::ERROR_STATUS_CODE.as_u16(),
|
||||||
"Error '{}' test failed.",
|
"Error '{}' test failed.",
|
||||||
type_name
|
type_name
|
||||||
);
|
);
|
||||||
@@ -439,8 +438,8 @@ impl TestExecutor {
|
|||||||
let invalid_builder = self.client.request(method, url);
|
let invalid_builder = self.client.request(method, url);
|
||||||
let invalid_response = T::set_invalid_request(invalid_builder).send().await?;
|
let invalid_response = T::set_invalid_request(invalid_builder).send().await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
invalid_response.status(),
|
invalid_response.status().as_u16(),
|
||||||
T::INVALID_STATUS_CODE,
|
T::INVALID_STATUS_CODE.as_u16(),
|
||||||
"Invalid '{}' test failed.",
|
"Invalid '{}' test failed.",
|
||||||
type_name
|
type_name
|
||||||
);
|
);
|
||||||
@@ -463,8 +462,8 @@ impl TestExecutor {
|
|||||||
#[cfg(feature = "into_json")]
|
#[cfg(feature = "into_json")]
|
||||||
pub async fn check_json(type_name: &'static str, response: reqwest::Response) {
|
pub async fn check_json(type_name: &'static str, response: reqwest::Response) {
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
response.headers()[axum::http::header::CONTENT_TYPE],
|
response.headers()[reqwest::header::CONTENT_TYPE],
|
||||||
axum::http::HeaderValue::from_static(mime::APPLICATION_JSON.as_ref()),
|
reqwest::header::HeaderValue::from_static(mime::APPLICATION_JSON.as_ref()),
|
||||||
"'{}' rejection into json test failed",
|
"'{}' rejection into json test failed",
|
||||||
type_name
|
type_name
|
||||||
);
|
);
|
||||||
@@ -514,9 +513,9 @@ mod typed_header {
|
|||||||
|
|
||||||
use super::{validate_again, ParametersGarde};
|
use super::{validate_again, ParametersGarde};
|
||||||
use crate::Garde;
|
use crate::Garde;
|
||||||
use axum::headers::{Error, Header, HeaderName, HeaderValue};
|
|
||||||
use axum::http::StatusCode;
|
use axum::http::StatusCode;
|
||||||
use axum::TypedHeader;
|
use axum_extra::headers::{Error, Header, HeaderName, HeaderValue};
|
||||||
|
use axum_extra::typed_header::TypedHeader;
|
||||||
|
|
||||||
pub static AXUM_VALID_PARAMETERS: HeaderName = HeaderName::from_static("axum-valid-parameters");
|
pub static AXUM_VALID_PARAMETERS: HeaderName = HeaderName::from_static("axum-valid-parameters");
|
||||||
|
|
||||||
|
|||||||
@@ -70,14 +70,16 @@
|
|||||||
//!
|
//!
|
||||||
//! # #[tokio::main]
|
//! # #[tokio::main]
|
||||||
//! # async fn main() -> anyhow::Result<()> {
|
//! # async fn main() -> anyhow::Result<()> {
|
||||||
|
//! # use std::net::SocketAddr;
|
||||||
//! # use axum::Router;
|
//! # use axum::Router;
|
||||||
|
//! # use tokio::net::TcpListener;
|
||||||
//! # let router = Router::new();
|
//! # let router = Router::new();
|
||||||
//! # #[cfg(feature = "validator")]
|
//! # #[cfg(feature = "validator")]
|
||||||
//! # let router = router.nest("/validator", validator_example::router());
|
//! # let router = router.nest("/validator", validator_example::router());
|
||||||
//! # #[cfg(feature = "garde")]
|
//! # #[cfg(feature = "garde")]
|
||||||
//! # let router = router.nest("/garde", garde_example::router());
|
//! # let router = router.nest("/garde", garde_example::router());
|
||||||
//! # axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
//! # let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
//! # .serve(router.into_make_service())
|
//! # axum::serve(listener, router.into_make_service())
|
||||||
//! # .await?;
|
//! # .await?;
|
||||||
//! # Ok(())
|
//! # Ok(())
|
||||||
//! # }
|
//! # }
|
||||||
|
|||||||
@@ -9,21 +9,15 @@ pub mod form;
|
|||||||
pub mod garde;
|
pub mod garde;
|
||||||
#[cfg(feature = "json")]
|
#[cfg(feature = "json")]
|
||||||
pub mod json;
|
pub mod json;
|
||||||
#[cfg(feature = "msgpack")]
|
|
||||||
pub mod msgpack;
|
|
||||||
pub mod path;
|
pub mod path;
|
||||||
#[cfg(feature = "query")]
|
#[cfg(feature = "query")]
|
||||||
pub mod query;
|
pub mod query;
|
||||||
#[cfg(feature = "typed_header")]
|
#[cfg(feature = "typed_header")]
|
||||||
pub mod typed_header;
|
pub mod typed_header;
|
||||||
#[cfg(feature = "typed_multipart")]
|
|
||||||
pub mod typed_multipart;
|
|
||||||
#[cfg(feature = "validator")]
|
#[cfg(feature = "validator")]
|
||||||
pub mod validator;
|
pub mod validator;
|
||||||
#[cfg(feature = "validify")]
|
#[cfg(feature = "validify")]
|
||||||
pub mod validify;
|
pub mod validify;
|
||||||
#[cfg(feature = "yaml")]
|
|
||||||
pub mod yaml;
|
|
||||||
|
|
||||||
use axum::http::StatusCode;
|
use axum::http::StatusCode;
|
||||||
use axum::response::{IntoResponse, Response};
|
use axum::response::{IntoResponse, Response};
|
||||||
@@ -117,7 +111,8 @@ impl<V: Display, E: IntoResponse> IntoResponse for ValidationRejection<V, E> {
|
|||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use reqwest::{RequestBuilder, StatusCode};
|
use axum::http::StatusCode;
|
||||||
|
use reqwest::RequestBuilder;
|
||||||
|
|
||||||
/// # Valid test parameter
|
/// # Valid test parameter
|
||||||
pub trait ValidTestParameter: 'static {
|
pub trait ValidTestParameter: 'static {
|
||||||
|
|||||||
263
src/msgpack.rs
263
src/msgpack.rs
@@ -1,263 +0,0 @@
|
|||||||
//! # Support for `MsgPack<T>` and `MsgPackRaw<T>` from `axum-msgpack`
|
|
||||||
//!
|
|
||||||
//! ## Feature
|
|
||||||
//!
|
|
||||||
//! Enable the `msgpack` feature to use `Valid<MsgPack<T>>` and `Valid<MsgPackRaw<T>>`.
|
|
||||||
//!
|
|
||||||
//! ## Usage
|
|
||||||
//!
|
|
||||||
//! 1. Implement `Deserialize` and `Validate` for your data type `T`.
|
|
||||||
//! 2. In your handler function, use `Valid<MsgPack<T>>` or `Valid<MsgPackRaw<T>>` as some parameter's type.
|
|
||||||
//!
|
|
||||||
//! ## Example
|
|
||||||
//!
|
|
||||||
//! ```no_run
|
|
||||||
//! #[cfg(feature = "validator")]
|
|
||||||
//! mod validator_example {
|
|
||||||
//! use axum::routing::post;
|
|
||||||
//! use axum::Json;
|
|
||||||
//! use axum::Router;
|
|
||||||
//! use axum_msgpack::{MsgPack, MsgPackRaw};
|
|
||||||
//! use axum_valid::Valid;
|
|
||||||
//! use serde::Deserialize;
|
|
||||||
//! use validator::Validate;
|
|
||||||
//!
|
|
||||||
//! pub fn router() -> Router {
|
|
||||||
//! Router::new()
|
|
||||||
//! .route("/msgpack", post(handler))
|
|
||||||
//! .route("/msgpackraw", post(raw_handler))
|
|
||||||
//! }
|
|
||||||
//! async fn handler(Valid(MsgPack(parameter)): Valid<MsgPack<Parameter>>) {
|
|
||||||
//! assert!(parameter.validate().is_ok());
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! async fn raw_handler(Valid(MsgPackRaw(parameter)): Valid<MsgPackRaw<Parameter>>) {
|
|
||||||
//! assert!(parameter.validate().is_ok());
|
|
||||||
//! }
|
|
||||||
//! #[derive(Validate, Deserialize)]
|
|
||||||
//! pub struct Parameter {
|
|
||||||
//! #[validate(range(min = 5, max = 10))]
|
|
||||||
//! pub v0: i32,
|
|
||||||
//! #[validate(length(min = 1, max = 10))]
|
|
||||||
//! pub v1: String,
|
|
||||||
//! }
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! #[cfg(feature = "garde")]
|
|
||||||
//! mod garde_example {
|
|
||||||
//! use axum::routing::post;
|
|
||||||
//! use axum::Router;
|
|
||||||
//! use axum_msgpack::{MsgPack, MsgPackRaw};
|
|
||||||
//! use axum_valid::Garde;
|
|
||||||
//! use serde::Deserialize;
|
|
||||||
//! use garde::Validate;
|
|
||||||
//!
|
|
||||||
//! pub fn router() -> Router {
|
|
||||||
//! Router::new()
|
|
||||||
//! .route("/msgpack", post(handler))
|
|
||||||
//! .route("/msgpackraw", post(raw_handler))
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! async fn handler(Garde(MsgPack(parameter)): Garde<MsgPack<Parameter>>) {
|
|
||||||
//! assert!(parameter.validate(&()).is_ok());
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! async fn raw_handler(Garde(MsgPackRaw(parameter)): Garde<MsgPackRaw<Parameter>>) {
|
|
||||||
//! assert!(parameter.validate(&()).is_ok());
|
|
||||||
//! }
|
|
||||||
//! #[derive(Validate, Deserialize)]
|
|
||||||
//! pub struct Parameter {
|
|
||||||
//! #[garde(range(min = 5, max = 10))]
|
|
||||||
//! pub v0: i32,
|
|
||||||
//! #[garde(length(min = 1, max = 10))]
|
|
||||||
//! pub v1: String,
|
|
||||||
//! }
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! # #[tokio::main]
|
|
||||||
//! # async fn main() -> anyhow::Result<()> {
|
|
||||||
//! # use axum::Router;
|
|
||||||
//! # let router = Router::new();
|
|
||||||
//! # #[cfg(feature = "validator")]
|
|
||||||
//! # let router = router.nest("/validator", validator_example::router());
|
|
||||||
//! # #[cfg(feature = "garde")]
|
|
||||||
//! # let router = router.nest("/garde", garde_example::router());
|
|
||||||
//! # axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
|
||||||
//! # .serve(router.into_make_service())
|
|
||||||
//! # .await?;
|
|
||||||
//! # Ok(())
|
|
||||||
//! # }
|
|
||||||
//! ```
|
|
||||||
//!
|
|
||||||
|
|
||||||
use crate::HasValidate;
|
|
||||||
#[cfg(feature = "validator")]
|
|
||||||
use crate::HasValidateArgs;
|
|
||||||
use axum_msgpack::{MsgPack, MsgPackRaw};
|
|
||||||
#[cfg(feature = "validator")]
|
|
||||||
use validator::ValidateArgs;
|
|
||||||
|
|
||||||
impl<T> HasValidate for MsgPack<T> {
|
|
||||||
type Validate = T;
|
|
||||||
fn get_validate(&self) -> &T {
|
|
||||||
&self.0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "validator")]
|
|
||||||
impl<'v, T: ValidateArgs<'v>> HasValidateArgs<'v> for MsgPack<T> {
|
|
||||||
type ValidateArgs = T;
|
|
||||||
fn get_validate_args(&self) -> &Self::ValidateArgs {
|
|
||||||
&self.0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "validify")]
|
|
||||||
impl<T: validify::Modify> crate::HasModify for MsgPack<T> {
|
|
||||||
type Modify = T;
|
|
||||||
|
|
||||||
fn get_modify(&mut self) -> &mut Self::Modify {
|
|
||||||
&mut self.0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "validify")]
|
|
||||||
impl<T> crate::PayloadExtractor for MsgPack<T> {
|
|
||||||
type Payload = T;
|
|
||||||
|
|
||||||
fn get_payload(self) -> Self::Payload {
|
|
||||||
self.0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "validify")]
|
|
||||||
impl<T: validify::Validify> crate::HasValidify for MsgPack<T> {
|
|
||||||
type Validify = T;
|
|
||||||
type PayloadExtractor = MsgPack<T::Payload>;
|
|
||||||
fn from_validified(v: Self::Validify) -> Self {
|
|
||||||
MsgPack(v)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T> HasValidate for MsgPackRaw<T> {
|
|
||||||
type Validate = T;
|
|
||||||
fn get_validate(&self) -> &T {
|
|
||||||
&self.0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "validator")]
|
|
||||||
impl<'v, T: ValidateArgs<'v>> HasValidateArgs<'v> for MsgPackRaw<T> {
|
|
||||||
type ValidateArgs = T;
|
|
||||||
fn get_validate_args(&self) -> &Self::ValidateArgs {
|
|
||||||
&self.0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "validify")]
|
|
||||||
impl<T: validify::Modify> crate::HasModify for MsgPackRaw<T> {
|
|
||||||
type Modify = T;
|
|
||||||
|
|
||||||
fn get_modify(&mut self) -> &mut Self::Modify {
|
|
||||||
&mut self.0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "validify")]
|
|
||||||
impl<T> crate::PayloadExtractor for MsgPackRaw<T> {
|
|
||||||
type Payload = T;
|
|
||||||
|
|
||||||
fn get_payload(self) -> Self::Payload {
|
|
||||||
self.0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "validify")]
|
|
||||||
impl<T: validify::Validify> crate::HasValidify for MsgPackRaw<T> {
|
|
||||||
type Validify = T;
|
|
||||||
type PayloadExtractor = MsgPackRaw<T::Payload>;
|
|
||||||
fn from_validified(v: Self::Validify) -> Self {
|
|
||||||
MsgPackRaw(v)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
use crate::tests::{ValidTest, ValidTestParameter};
|
|
||||||
use axum::http::StatusCode;
|
|
||||||
use axum_msgpack::{MsgPack, MsgPackRaw};
|
|
||||||
use reqwest::RequestBuilder;
|
|
||||||
use serde::Serialize;
|
|
||||||
|
|
||||||
impl<T: ValidTestParameter + Serialize> ValidTest for MsgPack<T> {
|
|
||||||
const ERROR_STATUS_CODE: StatusCode = StatusCode::BAD_REQUEST;
|
|
||||||
|
|
||||||
fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {
|
|
||||||
builder
|
|
||||||
.header(reqwest::header::CONTENT_TYPE, "application/msgpack")
|
|
||||||
.body(
|
|
||||||
rmp_serde::to_vec_named(T::valid())
|
|
||||||
.expect("Failed to serialize parameters to msgpack"),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_error_request(builder: RequestBuilder) -> RequestBuilder {
|
|
||||||
#[derive(Serialize, Default)]
|
|
||||||
struct ErrorData {
|
|
||||||
error_field0: i32,
|
|
||||||
error_field1: Option<String>,
|
|
||||||
}
|
|
||||||
builder
|
|
||||||
.header(reqwest::header::CONTENT_TYPE, "application/msgpack")
|
|
||||||
.body(
|
|
||||||
rmp_serde::to_vec(&ErrorData::default())
|
|
||||||
.expect("Failed to serialize parameters to msgpack"),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_invalid_request(builder: RequestBuilder) -> RequestBuilder {
|
|
||||||
builder
|
|
||||||
.header(reqwest::header::CONTENT_TYPE, "application/msgpack")
|
|
||||||
.body(
|
|
||||||
rmp_serde::to_vec_named(T::invalid())
|
|
||||||
.expect("Failed to serialize parameters to msgpack"),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T: ValidTestParameter + Serialize> ValidTest for MsgPackRaw<T> {
|
|
||||||
const ERROR_STATUS_CODE: StatusCode = StatusCode::BAD_REQUEST;
|
|
||||||
|
|
||||||
fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {
|
|
||||||
builder
|
|
||||||
.header(reqwest::header::CONTENT_TYPE, "application/msgpack")
|
|
||||||
.body(
|
|
||||||
rmp_serde::to_vec(T::valid())
|
|
||||||
.expect("Failed to serialize parameters to msgpack"),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_error_request(builder: RequestBuilder) -> RequestBuilder {
|
|
||||||
#[derive(Serialize, Default)]
|
|
||||||
struct ErrorData {
|
|
||||||
error_field0: i32,
|
|
||||||
error_field1: Option<String>,
|
|
||||||
}
|
|
||||||
builder
|
|
||||||
.header(reqwest::header::CONTENT_TYPE, "application/msgpack")
|
|
||||||
.body(
|
|
||||||
rmp_serde::to_vec(&ErrorData::default())
|
|
||||||
.expect("Failed to serialize parameters to msgpack"),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_invalid_request(builder: RequestBuilder) -> RequestBuilder {
|
|
||||||
builder
|
|
||||||
.header(reqwest::header::CONTENT_TYPE, "application/msgpack")
|
|
||||||
.body(
|
|
||||||
rmp_serde::to_vec(T::invalid())
|
|
||||||
.expect("Failed to serialize parameters to msgpack"),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -66,14 +66,16 @@
|
|||||||
//!
|
//!
|
||||||
//! # #[tokio::main]
|
//! # #[tokio::main]
|
||||||
//! # async fn main() -> anyhow::Result<()> {
|
//! # async fn main() -> anyhow::Result<()> {
|
||||||
|
//! # use std::net::SocketAddr;
|
||||||
//! # use axum::Router;
|
//! # use axum::Router;
|
||||||
|
//! # use tokio::net::TcpListener;
|
||||||
//! # let router = Router::new();
|
//! # let router = Router::new();
|
||||||
//! # #[cfg(feature = "validator")]
|
//! # #[cfg(feature = "validator")]
|
||||||
//! # let router = router.nest("/validator", validator_example::router());
|
//! # let router = router.nest("/validator", validator_example::router());
|
||||||
//! # #[cfg(feature = "garde")]
|
//! # #[cfg(feature = "garde")]
|
||||||
//! # let router = router.nest("/garde", garde_example::router());
|
//! # let router = router.nest("/garde", garde_example::router());
|
||||||
//! # axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
//! # let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
//! # .serve(router.into_make_service())
|
//! # axum::serve(listener, router.into_make_service())
|
||||||
//! # .await?;
|
//! # .await?;
|
||||||
//! # Ok(())
|
//! # Ok(())
|
||||||
//! # }
|
//! # }
|
||||||
|
|||||||
@@ -70,14 +70,16 @@
|
|||||||
//!
|
//!
|
||||||
//! # #[tokio::main]
|
//! # #[tokio::main]
|
||||||
//! # async fn main() -> anyhow::Result<()> {
|
//! # async fn main() -> anyhow::Result<()> {
|
||||||
|
//! # use std::net::SocketAddr;
|
||||||
//! # use axum::Router;
|
//! # use axum::Router;
|
||||||
|
//! # use tokio::net::TcpListener;
|
||||||
//! # let router = Router::new();
|
//! # let router = Router::new();
|
||||||
//! # #[cfg(feature = "validator")]
|
//! # #[cfg(feature = "validator")]
|
||||||
//! # let router = router.nest("/validator", validator_example::router());
|
//! # let router = router.nest("/validator", validator_example::router());
|
||||||
//! # #[cfg(feature = "garde")]
|
//! # #[cfg(feature = "garde")]
|
||||||
//! # let router = router.nest("/garde", garde_example::router());
|
//! # let router = router.nest("/garde", garde_example::router());
|
||||||
//! # axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
//! # let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
//! # .serve(router.into_make_service())
|
//! # axum::serve(listener, router.into_make_service())
|
||||||
//! # .await?;
|
//! # .await?;
|
||||||
//! # Ok(())
|
//! # Ok(())
|
||||||
//! # }
|
//! # }
|
||||||
|
|||||||
@@ -14,10 +14,11 @@
|
|||||||
//! ```no_run
|
//! ```no_run
|
||||||
//! #[cfg(feature = "validator")]
|
//! #[cfg(feature = "validator")]
|
||||||
//! mod validator_example {
|
//! mod validator_example {
|
||||||
//! use axum::headers::{Error, Header, HeaderValue};
|
//! use axum_extra::headers::{Error, Header, HeaderValue};
|
||||||
|
//! use axum_extra::typed_header::TypedHeader;
|
||||||
//! use axum::http::HeaderName;
|
//! use axum::http::HeaderName;
|
||||||
//! use axum::routing::post;
|
//! use axum::routing::post;
|
||||||
//! use axum::{Router, TypedHeader};
|
//! use axum::Router;
|
||||||
//! use axum_valid::Valid;
|
//! use axum_valid::Valid;
|
||||||
//! use validator::Validate;
|
//! use validator::Validate;
|
||||||
//!
|
//!
|
||||||
@@ -60,10 +61,11 @@
|
|||||||
//!
|
//!
|
||||||
//! #[cfg(feature = "garde")]
|
//! #[cfg(feature = "garde")]
|
||||||
//! mod garde_example {
|
//! mod garde_example {
|
||||||
//! use axum::headers::{Error, Header, HeaderValue};
|
//! use axum_extra::headers::{Error, Header, HeaderValue};
|
||||||
|
//! use axum_extra::typed_header::TypedHeader;
|
||||||
//! use axum::http::HeaderName;
|
//! use axum::http::HeaderName;
|
||||||
//! use axum::routing::post;
|
//! use axum::routing::post;
|
||||||
//! use axum::{Router, TypedHeader};
|
//! use axum::Router;
|
||||||
//! use axum_valid::Garde;
|
//! use axum_valid::Garde;
|
||||||
//! use garde::Validate;
|
//! use garde::Validate;
|
||||||
//!
|
//!
|
||||||
@@ -106,14 +108,16 @@
|
|||||||
//!
|
//!
|
||||||
//! # #[tokio::main]
|
//! # #[tokio::main]
|
||||||
//! # async fn main() -> anyhow::Result<()> {
|
//! # async fn main() -> anyhow::Result<()> {
|
||||||
|
//! # use std::net::SocketAddr;
|
||||||
//! # use axum::Router;
|
//! # use axum::Router;
|
||||||
|
//! # use tokio::net::TcpListener;
|
||||||
//! # let router = Router::new();
|
//! # let router = Router::new();
|
||||||
//! # #[cfg(feature = "validator")]
|
//! # #[cfg(feature = "validator")]
|
||||||
//! # let router = router.nest("/validator", validator_example::router());
|
//! # let router = router.nest("/validator", validator_example::router());
|
||||||
//! # #[cfg(feature = "garde")]
|
//! # #[cfg(feature = "garde")]
|
||||||
//! # let router = router.nest("/garde", garde_example::router());
|
//! # let router = router.nest("/garde", garde_example::router());
|
||||||
//! # axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
//! # let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
//! # .serve(router.into_make_service())
|
//! # axum::serve(listener, router.into_make_service())
|
||||||
//! # .await?;
|
//! # .await?;
|
||||||
//! # Ok(())
|
//! # Ok(())
|
||||||
//! # }
|
//! # }
|
||||||
@@ -122,7 +126,7 @@
|
|||||||
use crate::HasValidate;
|
use crate::HasValidate;
|
||||||
#[cfg(feature = "validator")]
|
#[cfg(feature = "validator")]
|
||||||
use crate::HasValidateArgs;
|
use crate::HasValidateArgs;
|
||||||
use axum::TypedHeader;
|
use axum_extra::typed_header::TypedHeader;
|
||||||
#[cfg(feature = "validator")]
|
#[cfg(feature = "validator")]
|
||||||
use validator::ValidateArgs;
|
use validator::ValidateArgs;
|
||||||
|
|
||||||
@@ -153,18 +157,24 @@ impl<T: validify::Modify> crate::HasModify for TypedHeader<T> {
|
|||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use crate::tests::{ValidTest, ValidTestParameter};
|
use crate::tests::{ValidTest, ValidTestParameter};
|
||||||
use axum::headers::{Header, HeaderMapExt};
|
|
||||||
use axum::http::StatusCode;
|
use axum::http::StatusCode;
|
||||||
use axum::TypedHeader;
|
use axum_extra::headers::Header;
|
||||||
use reqwest::header::HeaderMap;
|
use axum_extra::typed_header::TypedHeader;
|
||||||
|
use reqwest::header::{HeaderMap, HeaderValue};
|
||||||
use reqwest::RequestBuilder;
|
use reqwest::RequestBuilder;
|
||||||
|
|
||||||
impl<T: ValidTestParameter + Header + Clone> ValidTest for TypedHeader<T> {
|
impl<T: ValidTestParameter + Header + Clone> ValidTest for TypedHeader<T> {
|
||||||
const ERROR_STATUS_CODE: StatusCode = StatusCode::BAD_REQUEST;
|
const ERROR_STATUS_CODE: StatusCode = StatusCode::BAD_REQUEST;
|
||||||
|
|
||||||
fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {
|
fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {
|
||||||
|
let mut vec = Vec::new();
|
||||||
|
T::valid().encode(&mut vec);
|
||||||
|
let hv = vec.pop().unwrap();
|
||||||
let mut headers = HeaderMap::default();
|
let mut headers = HeaderMap::default();
|
||||||
headers.typed_insert(T::valid().clone());
|
headers.insert(
|
||||||
|
T::name().as_str(),
|
||||||
|
HeaderValue::from_bytes(hv.as_bytes()).unwrap(),
|
||||||
|
);
|
||||||
builder.headers(headers)
|
builder.headers(headers)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -173,8 +183,14 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn set_invalid_request(builder: RequestBuilder) -> RequestBuilder {
|
fn set_invalid_request(builder: RequestBuilder) -> RequestBuilder {
|
||||||
|
let mut vec = Vec::new();
|
||||||
|
T::invalid().encode(&mut vec);
|
||||||
|
let hv = vec.pop().unwrap();
|
||||||
let mut headers = HeaderMap::default();
|
let mut headers = HeaderMap::default();
|
||||||
headers.typed_insert(T::invalid().clone());
|
headers.insert(
|
||||||
|
T::name().as_str(),
|
||||||
|
HeaderValue::from_bytes(hv.as_bytes()).unwrap(),
|
||||||
|
);
|
||||||
builder.headers(headers)
|
builder.headers(headers)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,205 +0,0 @@
|
|||||||
//! # Support for `TypedMultipart<T>` and `BaseMultipart<T, R>` from `axum_typed_multipart`
|
|
||||||
//!
|
|
||||||
//! ## Feature
|
|
||||||
//!
|
|
||||||
//! Enable the `typed_multipart` feature to use `Valid<TypedMultipart<T>>` and `Valid<BaseMultipart<T, R>>`.
|
|
||||||
//!
|
|
||||||
//! ## Usage
|
|
||||||
//!
|
|
||||||
//! 1. Implement `TryFromMultipart` and `Validate` for your data type `T`.
|
|
||||||
//! 2. In your handler function, use `Valid<TypedMultipart<T>>` or `Valid<BaseMultipart<T, E>` as some parameter's type.
|
|
||||||
//!
|
|
||||||
//! ## Example
|
|
||||||
//!
|
|
||||||
//! ```no_run
|
|
||||||
//! #[cfg(feature = "validator")]
|
|
||||||
//! mod validator_example {
|
|
||||||
//! use axum::routing::post;
|
|
||||||
//! use axum::Router;
|
|
||||||
//! use axum_typed_multipart::{BaseMultipart, TryFromMultipart, TypedMultipart, TypedMultipartError};
|
|
||||||
//! use axum_valid::Valid;
|
|
||||||
//! use validator::Validate;
|
|
||||||
//!
|
|
||||||
//! pub fn router() -> Router {
|
|
||||||
//! Router::new()
|
|
||||||
//! .route("/typed_multipart", post(handler))
|
|
||||||
//! .route("/base_multipart", post(base_handler))
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! async fn handler(Valid(TypedMultipart(parameter)): Valid<TypedMultipart<Parameter>>) {
|
|
||||||
//! assert!(parameter.validate().is_ok());
|
|
||||||
//! // Support automatic dereferencing
|
|
||||||
//! println!("v0 = {}, v1 = {}", parameter.v0, parameter.v1);
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! async fn base_handler(
|
|
||||||
//! Valid(BaseMultipart {
|
|
||||||
//! data: parameter, ..
|
|
||||||
//! }): Valid<BaseMultipart<Parameter, TypedMultipartError>>,
|
|
||||||
//! ) {
|
|
||||||
//! assert!(parameter.validate().is_ok());
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! #[derive(TryFromMultipart, Validate)]
|
|
||||||
//! struct Parameter {
|
|
||||||
//! #[validate(range(min = 5, max = 10))]
|
|
||||||
//! v0: i32,
|
|
||||||
//! #[validate(length(min = 1, max = 10))]
|
|
||||||
//! v1: String,
|
|
||||||
//! }
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! #[cfg(feature = "garde")]
|
|
||||||
//! mod garde_example {
|
|
||||||
//! use axum::routing::post;
|
|
||||||
//! use axum::Router;
|
|
||||||
//! use axum_typed_multipart::{BaseMultipart, TryFromMultipart, TypedMultipart, TypedMultipartError};
|
|
||||||
//! use axum_valid::Garde;
|
|
||||||
//! use serde::Deserialize;
|
|
||||||
//! use garde::Validate;
|
|
||||||
//!
|
|
||||||
//! pub fn router() -> Router {
|
|
||||||
//! Router::new()
|
|
||||||
//! .route("/typed_multipart", post(handler))
|
|
||||||
//! .route("/base_multipart", post(base_handler))
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! async fn handler(Garde(TypedMultipart(parameter)): Garde<TypedMultipart<Parameter>>) {
|
|
||||||
//! assert!(parameter.validate(&()).is_ok());
|
|
||||||
//! // Support automatic dereferencing
|
|
||||||
//! println!("v0 = {}, v1 = {}", parameter.v0, parameter.v1);
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! async fn base_handler(
|
|
||||||
//! Garde(BaseMultipart {
|
|
||||||
//! data: parameter, ..
|
|
||||||
//! }): Garde<BaseMultipart<Parameter, TypedMultipartError>>,
|
|
||||||
//! ) {
|
|
||||||
//! assert!(parameter.validate(&()).is_ok());
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! #[derive(TryFromMultipart, Validate)]
|
|
||||||
//! pub struct Parameter {
|
|
||||||
//! #[garde(range(min = 5, max = 10))]
|
|
||||||
//! pub v0: i32,
|
|
||||||
//! #[garde(length(min = 1, max = 10))]
|
|
||||||
//! pub v1: String,
|
|
||||||
//! }
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! # #[tokio::main]
|
|
||||||
//! # async fn main() -> anyhow::Result<()> {
|
|
||||||
//! # use axum::Router;
|
|
||||||
//! # let router = Router::new();
|
|
||||||
//! # #[cfg(feature = "validator")]
|
|
||||||
//! # let router = router.nest("/validator", validator_example::router());
|
|
||||||
//! # #[cfg(feature = "garde")]
|
|
||||||
//! # let router = router.nest("/garde", garde_example::router());
|
|
||||||
//! # axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
|
||||||
//! # .serve(router.into_make_service())
|
|
||||||
//! # .await?;
|
|
||||||
//! # Ok(())
|
|
||||||
//! # }
|
|
||||||
//! ```
|
|
||||||
|
|
||||||
use crate::HasValidate;
|
|
||||||
#[cfg(feature = "validator")]
|
|
||||||
use crate::HasValidateArgs;
|
|
||||||
use axum_typed_multipart::{BaseMultipart, TypedMultipart};
|
|
||||||
#[cfg(feature = "validator")]
|
|
||||||
use validator::ValidateArgs;
|
|
||||||
|
|
||||||
impl<T, R> HasValidate for BaseMultipart<T, R> {
|
|
||||||
type Validate = T;
|
|
||||||
fn get_validate(&self) -> &T {
|
|
||||||
&self.data
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "validator")]
|
|
||||||
impl<'v, T: ValidateArgs<'v>, R> HasValidateArgs<'v> for BaseMultipart<T, R> {
|
|
||||||
type ValidateArgs = T;
|
|
||||||
fn get_validate_args(&self) -> &Self::ValidateArgs {
|
|
||||||
&self.data
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "validify")]
|
|
||||||
impl<T: validify::Modify, R> crate::HasModify for BaseMultipart<T, R> {
|
|
||||||
type Modify = T;
|
|
||||||
|
|
||||||
fn get_modify(&mut self) -> &mut Self::Modify {
|
|
||||||
&mut self.data
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T> HasValidate for TypedMultipart<T> {
|
|
||||||
type Validate = T;
|
|
||||||
fn get_validate(&self) -> &T {
|
|
||||||
&self.0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "validator")]
|
|
||||||
impl<'v, T: ValidateArgs<'v>> HasValidateArgs<'v> for TypedMultipart<T> {
|
|
||||||
type ValidateArgs = T;
|
|
||||||
fn get_validate_args(&self) -> &Self::ValidateArgs {
|
|
||||||
&self.0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "validify")]
|
|
||||||
impl<T: validify::Modify> crate::HasModify for TypedMultipart<T> {
|
|
||||||
type Modify = T;
|
|
||||||
|
|
||||||
fn get_modify(&mut self) -> &mut Self::Modify {
|
|
||||||
&mut self.0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
use crate::tests::{ValidTest, ValidTestParameter};
|
|
||||||
use axum::http::StatusCode;
|
|
||||||
use axum_typed_multipart::{BaseMultipart, TypedMultipart};
|
|
||||||
use reqwest::multipart::Form;
|
|
||||||
use reqwest::RequestBuilder;
|
|
||||||
|
|
||||||
impl<T: ValidTestParameter, R> ValidTest for BaseMultipart<T, R>
|
|
||||||
where
|
|
||||||
Form: From<&'static T>,
|
|
||||||
{
|
|
||||||
const ERROR_STATUS_CODE: StatusCode = StatusCode::BAD_REQUEST;
|
|
||||||
|
|
||||||
fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {
|
|
||||||
builder.multipart(Form::from(T::valid()))
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_error_request(builder: RequestBuilder) -> RequestBuilder {
|
|
||||||
builder.multipart(Form::new())
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_invalid_request(builder: RequestBuilder) -> RequestBuilder {
|
|
||||||
builder.multipart(Form::from(T::invalid()))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T: ValidTestParameter> ValidTest for TypedMultipart<T>
|
|
||||||
where
|
|
||||||
Form: From<&'static T>,
|
|
||||||
{
|
|
||||||
const ERROR_STATUS_CODE: StatusCode = StatusCode::BAD_REQUEST;
|
|
||||||
|
|
||||||
fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {
|
|
||||||
builder.multipart(Form::from(T::valid()))
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_error_request(builder: RequestBuilder) -> RequestBuilder {
|
|
||||||
builder.multipart(Form::new())
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_invalid_request(builder: RequestBuilder) -> RequestBuilder {
|
|
||||||
builder.multipart(Form::from(T::invalid()))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -10,9 +10,8 @@ pub mod test;
|
|||||||
|
|
||||||
use crate::{HasValidate, ValidationRejection};
|
use crate::{HasValidate, ValidationRejection};
|
||||||
use axum::async_trait;
|
use axum::async_trait;
|
||||||
use axum::extract::{FromRef, FromRequest, FromRequestParts};
|
use axum::extract::{FromRef, FromRequest, FromRequestParts, Request};
|
||||||
use axum::http::request::Parts;
|
use axum::http::request::Parts;
|
||||||
use axum::http::Request;
|
|
||||||
use std::fmt::Display;
|
use std::fmt::Display;
|
||||||
use std::ops::{Deref, DerefMut};
|
use std::ops::{Deref, DerefMut};
|
||||||
use validator::{Validate, ValidateArgs, ValidationErrors};
|
use validator::{Validate, ValidateArgs, ValidationErrors};
|
||||||
@@ -155,16 +154,15 @@ pub trait HasValidateArgs<'v> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[async_trait]
|
#[async_trait]
|
||||||
impl<State, Body, Extractor> FromRequest<State, Body> for Valid<Extractor>
|
impl<State, Extractor> FromRequest<State> for Valid<Extractor>
|
||||||
where
|
where
|
||||||
State: Send + Sync,
|
State: Send + Sync,
|
||||||
Body: Send + Sync + 'static,
|
Extractor: HasValidate + FromRequest<State>,
|
||||||
Extractor: HasValidate + FromRequest<State, Body>,
|
|
||||||
Extractor::Validate: Validate,
|
Extractor::Validate: Validate,
|
||||||
{
|
{
|
||||||
type Rejection = ValidRejection<<Extractor as FromRequest<State, Body>>::Rejection>;
|
type Rejection = ValidRejection<<Extractor as FromRequest<State>>::Rejection>;
|
||||||
|
|
||||||
async fn from_request(req: Request<Body>, state: &State) -> Result<Self, Self::Rejection> {
|
async fn from_request(req: Request, state: &State) -> Result<Self, Self::Rejection> {
|
||||||
let inner = Extractor::from_request(req, state)
|
let inner = Extractor::from_request(req, state)
|
||||||
.await
|
.await
|
||||||
.map_err(ValidRejection::Inner)?;
|
.map_err(ValidRejection::Inner)?;
|
||||||
@@ -192,19 +190,18 @@ where
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[async_trait]
|
#[async_trait]
|
||||||
impl<State, Body, Extractor, Args> FromRequest<State, Body> for ValidEx<Extractor, Args>
|
impl<State, Extractor, Args> FromRequest<State> for ValidEx<Extractor, Args>
|
||||||
where
|
where
|
||||||
State: Send + Sync,
|
State: Send + Sync,
|
||||||
Body: Send + Sync + 'static,
|
|
||||||
Args: Send
|
Args: Send
|
||||||
+ Sync
|
+ Sync
|
||||||
+ FromRef<State>
|
+ FromRef<State>
|
||||||
+ for<'a> Arguments<'a, T = <Extractor as HasValidateArgs<'a>>::ValidateArgs>,
|
+ for<'a> Arguments<'a, T = <Extractor as HasValidateArgs<'a>>::ValidateArgs>,
|
||||||
Extractor: for<'v> HasValidateArgs<'v> + FromRequest<State, Body>,
|
Extractor: for<'v> HasValidateArgs<'v> + FromRequest<State>,
|
||||||
{
|
{
|
||||||
type Rejection = ValidRejection<<Extractor as FromRequest<State, Body>>::Rejection>;
|
type Rejection = ValidRejection<<Extractor as FromRequest<State>>::Rejection>;
|
||||||
|
|
||||||
async fn from_request(req: Request<Body>, state: &State) -> Result<Self, Self::Rejection> {
|
async fn from_request(req: Request, state: &State) -> Result<Self, Self::Rejection> {
|
||||||
let arguments: Args = FromRef::from_ref(state);
|
let arguments: Args = FromRef::from_ref(state);
|
||||||
let inner = Extractor::from_request(req, state)
|
let inner = Extractor::from_request(req, state)
|
||||||
.await
|
.await
|
||||||
|
|||||||
@@ -3,24 +3,22 @@
|
|||||||
use crate::tests::{ValidTest, ValidTestParameter};
|
use crate::tests::{ValidTest, ValidTestParameter};
|
||||||
use crate::{Arguments, HasValidate, HasValidateArgs, Valid, ValidEx, VALIDATION_ERROR_STATUS};
|
use crate::{Arguments, HasValidate, HasValidateArgs, Valid, ValidEx, VALIDATION_ERROR_STATUS};
|
||||||
use axum::extract::{FromRef, Path, Query};
|
use axum::extract::{FromRef, Path, Query};
|
||||||
|
use axum::http::StatusCode;
|
||||||
use axum::routing::{get, post};
|
use axum::routing::{get, post};
|
||||||
use axum::{Form, Json, Router};
|
use axum::{Form, Json, Router};
|
||||||
use hyper::Method;
|
use hyper::Method;
|
||||||
use once_cell::sync::Lazy;
|
use once_cell::sync::Lazy;
|
||||||
use reqwest::{StatusCode, Url};
|
use reqwest::Url;
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
use std::any::type_name;
|
use std::any::type_name;
|
||||||
use std::net::SocketAddr;
|
use std::net::SocketAddr;
|
||||||
use std::ops::{Deref, RangeInclusive};
|
use std::ops::{Deref, RangeInclusive};
|
||||||
use std::sync::Arc;
|
use std::sync::Arc;
|
||||||
|
use tokio::net::TcpListener;
|
||||||
use validator::{Validate, ValidateArgs, ValidationError};
|
use validator::{Validate, ValidateArgs, ValidationError};
|
||||||
|
|
||||||
#[derive(Clone, Deserialize, Serialize, Validate, Eq, PartialEq)]
|
#[derive(Clone, Deserialize, Serialize, Validate, Eq, PartialEq)]
|
||||||
#[cfg_attr(feature = "extra_protobuf", derive(prost::Message))]
|
#[cfg_attr(feature = "extra_protobuf", derive(prost::Message))]
|
||||||
#[cfg_attr(
|
|
||||||
feature = "typed_multipart",
|
|
||||||
derive(axum_typed_multipart::TryFromMultipart)
|
|
||||||
)]
|
|
||||||
pub struct Parameters {
|
pub struct Parameters {
|
||||||
#[validate(range(min = 5, max = 10))]
|
#[validate(range(min = 5, max = 10))]
|
||||||
#[cfg_attr(feature = "extra_protobuf", prost(int32, tag = "1"))]
|
#[cfg_attr(feature = "extra_protobuf", prost(int32, tag = "1"))]
|
||||||
@@ -32,10 +30,6 @@ pub struct Parameters {
|
|||||||
|
|
||||||
#[derive(Clone, Deserialize, Serialize, Validate, Eq, PartialEq)]
|
#[derive(Clone, Deserialize, Serialize, Validate, Eq, PartialEq)]
|
||||||
#[cfg_attr(feature = "extra_protobuf", derive(prost::Message))]
|
#[cfg_attr(feature = "extra_protobuf", derive(prost::Message))]
|
||||||
#[cfg_attr(
|
|
||||||
feature = "typed_multipart",
|
|
||||||
derive(axum_typed_multipart::TryFromMultipart)
|
|
||||||
)]
|
|
||||||
pub struct ParametersEx {
|
pub struct ParametersEx {
|
||||||
#[validate(custom(function = "validate_v0", arg = "&'v_a RangeInclusive<i32>"))]
|
#[validate(custom(function = "validate_v0", arg = "&'v_a RangeInclusive<i32>"))]
|
||||||
#[cfg_attr(feature = "extra_protobuf", prost(int32, tag = "1"))]
|
#[cfg_attr(feature = "extra_protobuf", prost(int32, tag = "1"))]
|
||||||
@@ -271,15 +265,14 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
|
|
||||||
let router = router.with_state(state);
|
let router = router.with_state(state);
|
||||||
|
|
||||||
let server = axum::Server::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16)))
|
let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
.serve(router.into_make_service());
|
let server_addr = listener.local_addr()?;
|
||||||
let server_addr = server.local_addr();
|
let server = axum::serve(listener, router.into_make_service());
|
||||||
println!("Axum server address: {}.", server_addr);
|
println!("Axum server address: {}.", server_addr);
|
||||||
|
|
||||||
let (server_guard, close) = tokio::sync::oneshot::channel::<()>();
|
tokio::spawn(async move {
|
||||||
let server_handle = tokio::spawn(server.with_graceful_shutdown(async move {
|
let _ = server.await;
|
||||||
let _ = close.await;
|
});
|
||||||
}));
|
|
||||||
|
|
||||||
let server_url = format!("http://{}", server_addr);
|
let server_url = format!("http://{}", server_addr);
|
||||||
let test_executor = TestExecutor::from(Url::parse(&format!("http://{}", server_addr))?);
|
let test_executor = TestExecutor::from(Url::parse(&format!("http://{}", server_addr))?);
|
||||||
@@ -299,8 +292,8 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
valid_path_response.status(),
|
valid_path_response.status().as_u16(),
|
||||||
StatusCode::OK,
|
StatusCode::OK.as_u16(),
|
||||||
"Valid '{}' test failed.",
|
"Valid '{}' test failed.",
|
||||||
path_type_name
|
path_type_name
|
||||||
);
|
);
|
||||||
@@ -311,8 +304,8 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
error_path_response.status(),
|
error_path_response.status().as_u16(),
|
||||||
StatusCode::BAD_REQUEST,
|
StatusCode::BAD_REQUEST.as_u16(),
|
||||||
"Error '{}' test failed.",
|
"Error '{}' test failed.",
|
||||||
path_type_name
|
path_type_name
|
||||||
);
|
);
|
||||||
@@ -326,8 +319,8 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
invalid_path_response.status(),
|
invalid_path_response.status().as_u16(),
|
||||||
VALIDATION_ERROR_STATUS,
|
VALIDATION_ERROR_STATUS.as_u16(),
|
||||||
"Invalid '{}' test failed.",
|
"Invalid '{}' test failed.",
|
||||||
path_type_name
|
path_type_name
|
||||||
);
|
);
|
||||||
@@ -372,7 +365,7 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
|
|
||||||
#[cfg(feature = "typed_header")]
|
#[cfg(feature = "typed_header")]
|
||||||
{
|
{
|
||||||
use axum::TypedHeader;
|
use axum_extra::typed_header::TypedHeader;
|
||||||
// Valid
|
// Valid
|
||||||
test_executor
|
test_executor
|
||||||
.execute::<TypedHeader<Parameters>>(Method::POST, typed_header::route::TYPED_HEADER)
|
.execute::<TypedHeader<Parameters>>(Method::POST, typed_header::route::TYPED_HEADER)
|
||||||
@@ -476,8 +469,8 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
valid_extra_typed_path_response.status(),
|
valid_extra_typed_path_response.status().as_u16(),
|
||||||
StatusCode::OK,
|
StatusCode::OK.as_u16(),
|
||||||
"Valid '{}' test failed.",
|
"Valid '{}' test failed.",
|
||||||
extra_typed_path_type_name
|
extra_typed_path_type_name
|
||||||
);
|
);
|
||||||
@@ -488,8 +481,8 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
error_extra_typed_path_response.status(),
|
error_extra_typed_path_response.status().as_u16(),
|
||||||
StatusCode::BAD_REQUEST,
|
StatusCode::BAD_REQUEST.as_u16(),
|
||||||
"Error '{}' test failed.",
|
"Error '{}' test failed.",
|
||||||
extra_typed_path_type_name
|
extra_typed_path_type_name
|
||||||
);
|
);
|
||||||
@@ -503,8 +496,8 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
invalid_extra_typed_path_response.status(),
|
invalid_extra_typed_path_response.status().as_u16(),
|
||||||
VALIDATION_ERROR_STATUS,
|
VALIDATION_ERROR_STATUS.as_u16(),
|
||||||
"Invalid '{}' test failed.",
|
"Invalid '{}' test failed.",
|
||||||
extra_typed_path_type_name
|
extra_typed_path_type_name
|
||||||
);
|
);
|
||||||
@@ -583,8 +576,6 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.await?;
|
.await?;
|
||||||
}
|
}
|
||||||
|
|
||||||
drop(server_guard);
|
|
||||||
server_handle.await??;
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -617,8 +608,8 @@ impl TestExecutor {
|
|||||||
let valid_builder = self.client.request(method.clone(), url.clone());
|
let valid_builder = self.client.request(method.clone(), url.clone());
|
||||||
let valid_response = T::set_valid_request(valid_builder).send().await?;
|
let valid_response = T::set_valid_request(valid_builder).send().await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
valid_response.status(),
|
valid_response.status().as_u16(),
|
||||||
StatusCode::OK,
|
StatusCode::OK.as_u16(),
|
||||||
"Valid '{}' test failed.",
|
"Valid '{}' test failed.",
|
||||||
type_name
|
type_name
|
||||||
);
|
);
|
||||||
@@ -626,8 +617,8 @@ impl TestExecutor {
|
|||||||
let error_builder = self.client.request(method.clone(), url.clone());
|
let error_builder = self.client.request(method.clone(), url.clone());
|
||||||
let error_response = T::set_error_request(error_builder).send().await?;
|
let error_response = T::set_error_request(error_builder).send().await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
error_response.status(),
|
error_response.status().as_u16(),
|
||||||
T::ERROR_STATUS_CODE,
|
T::ERROR_STATUS_CODE.as_u16(),
|
||||||
"Error '{}' test failed.",
|
"Error '{}' test failed.",
|
||||||
type_name
|
type_name
|
||||||
);
|
);
|
||||||
@@ -635,8 +626,8 @@ impl TestExecutor {
|
|||||||
let invalid_builder = self.client.request(method, url);
|
let invalid_builder = self.client.request(method, url);
|
||||||
let invalid_response = T::set_invalid_request(invalid_builder).send().await?;
|
let invalid_response = T::set_invalid_request(invalid_builder).send().await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
invalid_response.status(),
|
invalid_response.status().as_u16(),
|
||||||
T::INVALID_STATUS_CODE,
|
T::INVALID_STATUS_CODE.as_u16(),
|
||||||
"Invalid '{}' test failed.",
|
"Invalid '{}' test failed.",
|
||||||
type_name
|
type_name
|
||||||
);
|
);
|
||||||
@@ -659,8 +650,8 @@ impl TestExecutor {
|
|||||||
#[cfg(feature = "into_json")]
|
#[cfg(feature = "into_json")]
|
||||||
pub async fn check_json(type_name: &'static str, response: reqwest::Response) {
|
pub async fn check_json(type_name: &'static str, response: reqwest::Response) {
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
response.headers()[axum::http::header::CONTENT_TYPE],
|
response.headers()[reqwest::header::CONTENT_TYPE],
|
||||||
axum::http::HeaderValue::from_static(mime::APPLICATION_JSON.as_ref()),
|
reqwest::header::HeaderValue::from_static(mime::APPLICATION_JSON.as_ref()),
|
||||||
"'{}' rejection into json test failed",
|
"'{}' rejection into json test failed",
|
||||||
type_name
|
type_name
|
||||||
);
|
);
|
||||||
@@ -754,9 +745,9 @@ mod typed_header {
|
|||||||
use super::{validate_again, Parameters};
|
use super::{validate_again, Parameters};
|
||||||
use super::{validate_again_ex, ParametersEx, ParametersExValidationArguments};
|
use super::{validate_again_ex, ParametersEx, ParametersExValidationArguments};
|
||||||
use crate::{Arguments, Valid, ValidEx};
|
use crate::{Arguments, Valid, ValidEx};
|
||||||
use axum::headers::{Error, Header, HeaderName, HeaderValue};
|
|
||||||
use axum::http::StatusCode;
|
use axum::http::StatusCode;
|
||||||
use axum::TypedHeader;
|
use axum_extra::headers::{Error, Header, HeaderName, HeaderValue};
|
||||||
|
use axum_extra::typed_header::TypedHeader;
|
||||||
|
|
||||||
pub static AXUM_VALID_PARAMETERS: HeaderName = HeaderName::from_static("axum-valid-parameters");
|
pub static AXUM_VALID_PARAMETERS: HeaderName = HeaderName::from_static("axum-valid-parameters");
|
||||||
|
|
||||||
|
|||||||
@@ -10,9 +10,8 @@ pub mod test;
|
|||||||
|
|
||||||
use crate::{HasValidate, ValidationRejection};
|
use crate::{HasValidate, ValidationRejection};
|
||||||
use axum::async_trait;
|
use axum::async_trait;
|
||||||
use axum::extract::{FromRequest, FromRequestParts};
|
use axum::extract::{FromRequest, FromRequestParts, Request};
|
||||||
use axum::http::request::Parts;
|
use axum::http::request::Parts;
|
||||||
use axum::http::Request;
|
|
||||||
use axum::response::{IntoResponse, Response};
|
use axum::response::{IntoResponse, Response};
|
||||||
use std::fmt::{Display, Formatter};
|
use std::fmt::{Display, Formatter};
|
||||||
use std::ops::{Deref, DerefMut};
|
use std::ops::{Deref, DerefMut};
|
||||||
@@ -241,16 +240,15 @@ pub trait HasValidify: Sized {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[async_trait]
|
#[async_trait]
|
||||||
impl<State, Body, Extractor> FromRequest<State, Body> for Validated<Extractor>
|
impl<State, Extractor> FromRequest<State> for Validated<Extractor>
|
||||||
where
|
where
|
||||||
State: Send + Sync,
|
State: Send + Sync,
|
||||||
Body: Send + Sync + 'static,
|
Extractor: HasValidate + FromRequest<State>,
|
||||||
Extractor: HasValidate + FromRequest<State, Body>,
|
|
||||||
Extractor::Validate: validify::Validate,
|
Extractor::Validate: validify::Validate,
|
||||||
{
|
{
|
||||||
type Rejection = ValidifyRejection<<Extractor as FromRequest<State, Body>>::Rejection>;
|
type Rejection = ValidifyRejection<<Extractor as FromRequest<State>>::Rejection>;
|
||||||
|
|
||||||
async fn from_request(req: Request<Body>, state: &State) -> Result<Self, Self::Rejection> {
|
async fn from_request(req: Request, state: &State) -> Result<Self, Self::Rejection> {
|
||||||
let inner = Extractor::from_request(req, state)
|
let inner = Extractor::from_request(req, state)
|
||||||
.await
|
.await
|
||||||
.map_err(ValidifyRejection::Inner)?;
|
.map_err(ValidifyRejection::Inner)?;
|
||||||
@@ -278,15 +276,14 @@ where
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[async_trait]
|
#[async_trait]
|
||||||
impl<State, Body, Extractor> FromRequest<State, Body> for Modified<Extractor>
|
impl<State, Extractor> FromRequest<State> for Modified<Extractor>
|
||||||
where
|
where
|
||||||
State: Send + Sync,
|
State: Send + Sync,
|
||||||
Body: Send + Sync + 'static,
|
Extractor: HasModify + FromRequest<State>,
|
||||||
Extractor: HasModify + FromRequest<State, Body>,
|
|
||||||
{
|
{
|
||||||
type Rejection = <Extractor as FromRequest<State, Body>>::Rejection;
|
type Rejection = <Extractor as FromRequest<State>>::Rejection;
|
||||||
|
|
||||||
async fn from_request(req: Request<Body>, state: &State) -> Result<Self, Self::Rejection> {
|
async fn from_request(req: Request, state: &State) -> Result<Self, Self::Rejection> {
|
||||||
let mut inner = Extractor::from_request(req, state).await?;
|
let mut inner = Extractor::from_request(req, state).await?;
|
||||||
inner.get_modify().modify();
|
inner.get_modify().modify();
|
||||||
Ok(Modified(inner))
|
Ok(Modified(inner))
|
||||||
@@ -309,18 +306,17 @@ where
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[async_trait]
|
#[async_trait]
|
||||||
impl<State, Body, Extractor> FromRequest<State, Body> for Validified<Extractor>
|
impl<State, Extractor> FromRequest<State> for Validified<Extractor>
|
||||||
where
|
where
|
||||||
State: Send + Sync,
|
State: Send + Sync,
|
||||||
Body: Send + Sync + 'static,
|
|
||||||
Extractor: HasValidify,
|
Extractor: HasValidify,
|
||||||
Extractor::Validify: Validify,
|
Extractor::Validify: Validify,
|
||||||
Extractor::PayloadExtractor: FromRequest<State, Body>,
|
Extractor::PayloadExtractor: FromRequest<State>,
|
||||||
{
|
{
|
||||||
type Rejection =
|
type Rejection =
|
||||||
ValidifyRejection<<Extractor::PayloadExtractor as FromRequest<State, Body>>::Rejection>;
|
ValidifyRejection<<Extractor::PayloadExtractor as FromRequest<State>>::Rejection>;
|
||||||
|
|
||||||
async fn from_request(req: Request<Body>, state: &State) -> Result<Self, Self::Rejection> {
|
async fn from_request(req: Request, state: &State) -> Result<Self, Self::Rejection> {
|
||||||
let payload = Extractor::PayloadExtractor::from_request(req, state)
|
let payload = Extractor::PayloadExtractor::from_request(req, state)
|
||||||
.await
|
.await
|
||||||
.map_err(ValidifyRejection::Inner)?;
|
.map_err(ValidifyRejection::Inner)?;
|
||||||
@@ -352,16 +348,15 @@ where
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[async_trait]
|
#[async_trait]
|
||||||
impl<State, Body, Extractor> FromRequest<State, Body> for ValidifiedByRef<Extractor>
|
impl<State, Extractor> FromRequest<State> for ValidifiedByRef<Extractor>
|
||||||
where
|
where
|
||||||
State: Send + Sync,
|
State: Send + Sync,
|
||||||
Body: Send + Sync + 'static,
|
Extractor: HasValidate + HasModify + FromRequest<State>,
|
||||||
Extractor: HasValidate + HasModify + FromRequest<State, Body>,
|
|
||||||
Extractor::Validate: Validate,
|
Extractor::Validate: Validate,
|
||||||
{
|
{
|
||||||
type Rejection = ValidifyRejection<<Extractor as FromRequest<State, Body>>::Rejection>;
|
type Rejection = ValidifyRejection<<Extractor as FromRequest<State>>::Rejection>;
|
||||||
|
|
||||||
async fn from_request(req: Request<Body>, state: &State) -> Result<Self, Self::Rejection> {
|
async fn from_request(req: Request, state: &State) -> Result<Self, Self::Rejection> {
|
||||||
let mut inner = Extractor::from_request(req, state)
|
let mut inner = Extractor::from_request(req, state)
|
||||||
.await
|
.await
|
||||||
.map_err(ValidifyRejection::Inner)?;
|
.map_err(ValidifyRejection::Inner)?;
|
||||||
|
|||||||
@@ -5,15 +5,17 @@ use crate::{
|
|||||||
HasValidate, Modified, Validated, Validified, ValidifiedByRef, VALIDATION_ERROR_STATUS,
|
HasValidate, Modified, Validated, Validified, ValidifiedByRef, VALIDATION_ERROR_STATUS,
|
||||||
};
|
};
|
||||||
use axum::extract::{Path, Query};
|
use axum::extract::{Path, Query};
|
||||||
|
use axum::http::StatusCode;
|
||||||
use axum::routing::{get, post};
|
use axum::routing::{get, post};
|
||||||
use axum::{Form, Json, Router};
|
use axum::{Form, Json, Router};
|
||||||
use hyper::Method;
|
use hyper::Method;
|
||||||
use once_cell::sync::Lazy;
|
use once_cell::sync::Lazy;
|
||||||
use reqwest::{StatusCode, Url};
|
use reqwest::Url;
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
use std::any::type_name;
|
use std::any::type_name;
|
||||||
use std::net::SocketAddr;
|
use std::net::SocketAddr;
|
||||||
use std::ops::Deref;
|
use std::ops::Deref;
|
||||||
|
use tokio::net::TcpListener;
|
||||||
use validify::{Modify, Validate, Validify};
|
use validify::{Modify, Validate, Validify};
|
||||||
|
|
||||||
#[derive(Clone, Deserialize, Serialize, Validify, Eq, PartialEq)]
|
#[derive(Clone, Deserialize, Serialize, Validify, Eq, PartialEq)]
|
||||||
@@ -300,15 +302,14 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
post(msgpack::extract_msgpack_raw_validified_by_ref),
|
post(msgpack::extract_msgpack_raw_validified_by_ref),
|
||||||
);
|
);
|
||||||
|
|
||||||
let server = axum::Server::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16)))
|
let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
.serve(router.into_make_service());
|
let server_addr = listener.local_addr()?;
|
||||||
let server_addr = server.local_addr();
|
let server = axum::serve(listener, router.into_make_service());
|
||||||
println!("Axum server address: {}.", server_addr);
|
println!("Axum server address: {}.", server_addr);
|
||||||
|
|
||||||
let (server_guard, close) = tokio::sync::oneshot::channel::<()>();
|
tokio::spawn(async move {
|
||||||
let server_handle = tokio::spawn(server.with_graceful_shutdown(async move {
|
let _ = server.await;
|
||||||
let _ = close.await;
|
});
|
||||||
}));
|
|
||||||
|
|
||||||
let server_url = format!("http://{}", server_addr);
|
let server_url = format!("http://{}", server_addr);
|
||||||
let test_executor = TestExecutor::from(Url::parse(&format!("http://{}", server_addr))?);
|
let test_executor = TestExecutor::from(Url::parse(&format!("http://{}", server_addr))?);
|
||||||
@@ -383,8 +384,8 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
valid_path_response.status(),
|
valid_path_response.status().as_u16(),
|
||||||
expected_valid_status,
|
expected_valid_status.as_u16(),
|
||||||
"Valid '{}' test failed.",
|
"Valid '{}' test failed.",
|
||||||
path_type_name
|
path_type_name
|
||||||
);
|
);
|
||||||
@@ -395,8 +396,8 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
error_path_response.status(),
|
error_path_response.status().as_u16(),
|
||||||
expected_error_status,
|
expected_error_status.as_u16(),
|
||||||
"Error '{}' test failed: {}",
|
"Error '{}' test failed: {}",
|
||||||
path_type_name,
|
path_type_name,
|
||||||
error_path_response.text().await?
|
error_path_response.text().await?
|
||||||
@@ -411,8 +412,8 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
invalid_path_response.status(),
|
invalid_path_response.status().as_u16(),
|
||||||
expected_invalid_status,
|
expected_invalid_status.as_u16(),
|
||||||
"Invalid '{}' test failed.",
|
"Invalid '{}' test failed.",
|
||||||
path_type_name
|
path_type_name
|
||||||
);
|
);
|
||||||
@@ -482,7 +483,7 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
|
|
||||||
#[cfg(feature = "typed_header")]
|
#[cfg(feature = "typed_header")]
|
||||||
{
|
{
|
||||||
use axum::TypedHeader;
|
use axum_extra::typed_header::TypedHeader;
|
||||||
// Validated
|
// Validated
|
||||||
test_executor
|
test_executor
|
||||||
.execute::<TypedHeader<ParametersValidify>>(
|
.execute::<TypedHeader<ParametersValidify>>(
|
||||||
@@ -683,8 +684,8 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
valid_extra_typed_path_response.status(),
|
valid_extra_typed_path_response.status().as_u16(),
|
||||||
expected_valid_status,
|
expected_valid_status.as_u16(),
|
||||||
"Validified '{}' test failed.",
|
"Validified '{}' test failed.",
|
||||||
extra_typed_path_type_name
|
extra_typed_path_type_name
|
||||||
);
|
);
|
||||||
@@ -695,8 +696,8 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
error_extra_typed_path_response.status(),
|
error_extra_typed_path_response.status().as_u16(),
|
||||||
expected_error_status,
|
expected_error_status.as_u16(),
|
||||||
"Error '{}' test failed.",
|
"Error '{}' test failed.",
|
||||||
extra_typed_path_type_name
|
extra_typed_path_type_name
|
||||||
);
|
);
|
||||||
@@ -710,8 +711,8 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
invalid_extra_typed_path_response.status(),
|
invalid_extra_typed_path_response.status().as_u16(),
|
||||||
expected_invalid_status,
|
expected_invalid_status.as_u16(),
|
||||||
"Invalid '{}' test failed.",
|
"Invalid '{}' test failed.",
|
||||||
extra_typed_path_type_name
|
extra_typed_path_type_name
|
||||||
);
|
);
|
||||||
@@ -906,8 +907,6 @@ async fn test_main() -> anyhow::Result<()> {
|
|||||||
.await?;
|
.await?;
|
||||||
}
|
}
|
||||||
|
|
||||||
drop(server_guard);
|
|
||||||
server_handle.await??;
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -994,8 +993,8 @@ impl TestExecutor {
|
|||||||
let valid_builder = self.client.request(method.clone(), url.clone());
|
let valid_builder = self.client.request(method.clone(), url.clone());
|
||||||
let valid_response = T::set_valid_request(valid_builder).send().await?;
|
let valid_response = T::set_valid_request(valid_builder).send().await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
valid_response.status(),
|
valid_response.status().as_u16(),
|
||||||
expected_valid_status,
|
expected_valid_status.as_u16(),
|
||||||
"Validified '{}' test failed: {}.",
|
"Validified '{}' test failed: {}.",
|
||||||
type_name,
|
type_name,
|
||||||
valid_response.text().await?
|
valid_response.text().await?
|
||||||
@@ -1004,8 +1003,8 @@ impl TestExecutor {
|
|||||||
let error_builder = self.client.request(method.clone(), url.clone());
|
let error_builder = self.client.request(method.clone(), url.clone());
|
||||||
let error_response = T::set_error_request(error_builder).send().await?;
|
let error_response = T::set_error_request(error_builder).send().await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
error_response.status(),
|
error_response.status().as_u16(),
|
||||||
expected_error_status,
|
expected_error_status.as_u16(),
|
||||||
"Error '{}' test failed: {}.",
|
"Error '{}' test failed: {}.",
|
||||||
type_name,
|
type_name,
|
||||||
error_response.text().await?
|
error_response.text().await?
|
||||||
@@ -1014,8 +1013,8 @@ impl TestExecutor {
|
|||||||
let invalid_builder = self.client.request(method, url);
|
let invalid_builder = self.client.request(method, url);
|
||||||
let invalid_response = T::set_invalid_request(invalid_builder).send().await?;
|
let invalid_response = T::set_invalid_request(invalid_builder).send().await?;
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
invalid_response.status(),
|
invalid_response.status().as_u16(),
|
||||||
expected_invalid_status,
|
expected_invalid_status.as_u16(),
|
||||||
"Invalid '{}' test failed: {}.",
|
"Invalid '{}' test failed: {}.",
|
||||||
type_name,
|
type_name,
|
||||||
invalid_response.text().await?
|
invalid_response.text().await?
|
||||||
@@ -1040,8 +1039,8 @@ impl TestExecutor {
|
|||||||
#[cfg(feature = "into_json")]
|
#[cfg(feature = "into_json")]
|
||||||
pub async fn check_json(type_name: &'static str, response: reqwest::Response) {
|
pub async fn check_json(type_name: &'static str, response: reqwest::Response) {
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
response.headers()[axum::http::header::CONTENT_TYPE],
|
response.headers()[reqwest::header::CONTENT_TYPE],
|
||||||
axum::http::HeaderValue::from_static(mime::APPLICATION_JSON.as_ref()),
|
reqwest::header::HeaderValue::from_static(mime::APPLICATION_JSON.as_ref()),
|
||||||
"'{}' rejection into json test failed",
|
"'{}' rejection into json test failed",
|
||||||
type_name
|
type_name
|
||||||
);
|
);
|
||||||
@@ -1206,9 +1205,9 @@ mod typed_header {
|
|||||||
|
|
||||||
use super::{check_modified, check_validated, check_validified, ParametersValidify};
|
use super::{check_modified, check_validated, check_validified, ParametersValidify};
|
||||||
use crate::{Modified, Validated, ValidifiedByRef};
|
use crate::{Modified, Validated, ValidifiedByRef};
|
||||||
use axum::headers::{Error, Header, HeaderName, HeaderValue};
|
|
||||||
use axum::http::StatusCode;
|
use axum::http::StatusCode;
|
||||||
use axum::TypedHeader;
|
use axum_extra::headers::{Error, Header, HeaderName, HeaderValue};
|
||||||
|
use axum_extra::typed_header::TypedHeader;
|
||||||
|
|
||||||
pub static AXUM_VALID_PARAMETERS: HeaderName = HeaderName::from_static("axum-valid-parameters");
|
pub static AXUM_VALID_PARAMETERS: HeaderName = HeaderName::from_static("axum-valid-parameters");
|
||||||
|
|
||||||
|
|||||||
176
src/yaml.rs
176
src/yaml.rs
@@ -1,176 +0,0 @@
|
|||||||
//! # Support for `Yaml<T>` from `axum-yaml`
|
|
||||||
//!
|
|
||||||
//! ## Feature
|
|
||||||
//!
|
|
||||||
//! Enable the `yaml` feature to use `Valid<Yaml<T>>`.
|
|
||||||
//!
|
|
||||||
//! ## Usage
|
|
||||||
//!
|
|
||||||
//! 1. Implement `Deserialize` and `Validate` for your data type `T`.
|
|
||||||
//! 2. In your handler function, use `Valid<Yaml<T>>` as some parameter's type.
|
|
||||||
//!
|
|
||||||
//! ## Example
|
|
||||||
//!
|
|
||||||
//! ```no_run
|
|
||||||
//! #[cfg(feature = "validator")]
|
|
||||||
//! mod validator_example {
|
|
||||||
//! use axum::routing::post;
|
|
||||||
//! use axum_yaml::Yaml;
|
|
||||||
//! use axum::Router;
|
|
||||||
//! use axum_valid::Valid;
|
|
||||||
//! use serde::Deserialize;
|
|
||||||
//! use validator::Validate;
|
|
||||||
//!
|
|
||||||
//! pub fn router() -> Router {
|
|
||||||
//! Router::new().route("/yaml", post(handler))
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! async fn handler(Valid(Yaml(parameter)): Valid<Yaml<Parameter>>) {
|
|
||||||
//! assert!(parameter.validate().is_ok());
|
|
||||||
//! // Support automatic dereferencing
|
|
||||||
//! println!("v0 = {}, v1 = {}", parameter.v0, parameter.v1);
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! #[derive(Validate, Deserialize)]
|
|
||||||
//! pub struct Parameter {
|
|
||||||
//! #[validate(range(min = 5, max = 10))]
|
|
||||||
//! pub v0: i32,
|
|
||||||
//! #[validate(length(min = 1, max = 10))]
|
|
||||||
//! pub v1: String,
|
|
||||||
//! }
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! #[cfg(feature = "garde")]
|
|
||||||
//! mod garde_example {
|
|
||||||
//! use axum::routing::post;
|
|
||||||
//! use axum_yaml::Yaml;
|
|
||||||
//! use axum::Router;
|
|
||||||
//! use axum_valid::Garde;
|
|
||||||
//! use serde::Deserialize;
|
|
||||||
//! use garde::Validate;
|
|
||||||
//!
|
|
||||||
//! pub fn router() -> Router {
|
|
||||||
//! Router::new().route("/yaml", post(handler))
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! async fn handler(Garde(Yaml(parameter)): Garde<Yaml<Parameter>>) {
|
|
||||||
//! assert!(parameter.validate(&()).is_ok());
|
|
||||||
//! // Support automatic dereferencing
|
|
||||||
//! println!("v0 = {}, v1 = {}", parameter.v0, parameter.v1);
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! #[derive(Validate, Deserialize)]
|
|
||||||
//! pub struct Parameter {
|
|
||||||
//! #[garde(range(min = 5, max = 10))]
|
|
||||||
//! pub v0: i32,
|
|
||||||
//! #[garde(length(min = 1, max = 10))]
|
|
||||||
//! pub v1: String,
|
|
||||||
//! }
|
|
||||||
//! }
|
|
||||||
//!
|
|
||||||
//! # #[tokio::main]
|
|
||||||
//! # async fn main() -> anyhow::Result<()> {
|
|
||||||
//! # use axum::Router;
|
|
||||||
//! # let router = Router::new();
|
|
||||||
//! # #[cfg(feature = "validator")]
|
|
||||||
//! # let router = router.nest("/validator", validator_example::router());
|
|
||||||
//! # #[cfg(feature = "garde")]
|
|
||||||
//! # let router = router.nest("/garde", garde_example::router());
|
|
||||||
//! # axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
|
|
||||||
//! # .serve(router.into_make_service())
|
|
||||||
//! # .await?;
|
|
||||||
//! # Ok(())
|
|
||||||
//! # }
|
|
||||||
//! ```
|
|
||||||
|
|
||||||
use crate::HasValidate;
|
|
||||||
#[cfg(feature = "validator")]
|
|
||||||
use crate::HasValidateArgs;
|
|
||||||
use axum_yaml::Yaml;
|
|
||||||
#[cfg(feature = "validator")]
|
|
||||||
use validator::ValidateArgs;
|
|
||||||
|
|
||||||
impl<T> HasValidate for Yaml<T> {
|
|
||||||
type Validate = T;
|
|
||||||
fn get_validate(&self) -> &T {
|
|
||||||
&self.0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "validator")]
|
|
||||||
impl<'v, T: ValidateArgs<'v>> HasValidateArgs<'v> for Yaml<T> {
|
|
||||||
type ValidateArgs = T;
|
|
||||||
fn get_validate_args(&self) -> &Self::ValidateArgs {
|
|
||||||
&self.0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "validify")]
|
|
||||||
impl<T: validify::Modify> crate::HasModify for Yaml<T> {
|
|
||||||
type Modify = T;
|
|
||||||
|
|
||||||
fn get_modify(&mut self) -> &mut Self::Modify {
|
|
||||||
&mut self.0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "validify")]
|
|
||||||
impl<T> crate::PayloadExtractor for Yaml<T> {
|
|
||||||
type Payload = T;
|
|
||||||
|
|
||||||
fn get_payload(self) -> Self::Payload {
|
|
||||||
self.0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "validify")]
|
|
||||||
impl<T: validify::Validify> crate::HasValidify for Yaml<T> {
|
|
||||||
type Validify = T;
|
|
||||||
type PayloadExtractor = Yaml<T::Payload>;
|
|
||||||
fn from_validified(v: Self::Validify) -> Self {
|
|
||||||
Yaml(v)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
use crate::tests::{ValidTest, ValidTestParameter};
|
|
||||||
use axum::http::StatusCode;
|
|
||||||
use axum_yaml::Yaml;
|
|
||||||
use reqwest::RequestBuilder;
|
|
||||||
use serde::Serialize;
|
|
||||||
|
|
||||||
impl<T: ValidTestParameter + Serialize> ValidTest for Yaml<T> {
|
|
||||||
const ERROR_STATUS_CODE: StatusCode = StatusCode::UNPROCESSABLE_ENTITY;
|
|
||||||
|
|
||||||
fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {
|
|
||||||
builder
|
|
||||||
.header(reqwest::header::CONTENT_TYPE, "application/yaml")
|
|
||||||
.body(
|
|
||||||
serde_yaml::to_string(&T::valid())
|
|
||||||
.expect("Failed to serialize parameters to yaml"),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_error_request(builder: RequestBuilder) -> RequestBuilder {
|
|
||||||
#[derive(Serialize, Default)]
|
|
||||||
struct ErrorData {
|
|
||||||
error_field: i32,
|
|
||||||
}
|
|
||||||
builder
|
|
||||||
.header(reqwest::header::CONTENT_TYPE, "application/yaml")
|
|
||||||
.body(
|
|
||||||
serde_yaml::to_string(&ErrorData::default())
|
|
||||||
.expect("Failed to serialize parameters to yaml"),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_invalid_request(builder: RequestBuilder) -> RequestBuilder {
|
|
||||||
builder
|
|
||||||
.header(reqwest::header::CONTENT_TYPE, "application/yaml")
|
|
||||||
.body(
|
|
||||||
serde_yaml::to_string(&T::invalid())
|
|
||||||
.expect("Failed to serialize parameters to yaml"),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -4,14 +4,14 @@
|
|||||||
#![cfg(feature = "validator")]
|
#![cfg(feature = "validator")]
|
||||||
|
|
||||||
use axum::extract::FromRequestParts;
|
use axum::extract::FromRequestParts;
|
||||||
use axum::http::request::Parts;
|
use axum::http::{request::Parts, StatusCode};
|
||||||
use axum::response::{IntoResponse, Response};
|
use axum::response::{IntoResponse, Response};
|
||||||
use axum::routing::get;
|
use axum::routing::get;
|
||||||
use axum::Router;
|
use axum::Router;
|
||||||
use axum_valid::{HasValidate, Valid, VALIDATION_ERROR_STATUS};
|
use axum_valid::{HasValidate, Valid, VALIDATION_ERROR_STATUS};
|
||||||
use hyper::StatusCode;
|
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
use std::net::SocketAddr;
|
use std::net::SocketAddr;
|
||||||
|
use tokio::net::TcpListener;
|
||||||
use validator::Validate;
|
use validator::Validate;
|
||||||
|
|
||||||
const MY_DATA_HEADER: &str = "My-Data";
|
const MY_DATA_HEADER: &str = "My-Data";
|
||||||
@@ -75,16 +75,15 @@ impl HasValidate for MyData {
|
|||||||
async fn main() -> anyhow::Result<()> {
|
async fn main() -> anyhow::Result<()> {
|
||||||
let router = Router::new().route("/", get(handler));
|
let router = Router::new().route("/", get(handler));
|
||||||
|
|
||||||
let server = axum::Server::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16)))
|
let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
|
||||||
.serve(router.into_make_service());
|
let server_addr = listener.local_addr()?;
|
||||||
|
let server = axum::serve(listener, router.into_make_service());
|
||||||
let server_addr = server.local_addr();
|
|
||||||
println!("Axum server address: {}.", server_addr);
|
println!("Axum server address: {}.", server_addr);
|
||||||
|
|
||||||
let (server_guard, close) = tokio::sync::oneshot::channel::<()>();
|
// let (server_guard, close) = tokio::sync::oneshot::channel::<()>();
|
||||||
let server_handle = tokio::spawn(server.with_graceful_shutdown(async move {
|
tokio::spawn(async move {
|
||||||
let _ = close.await;
|
let _ = server.await;
|
||||||
}));
|
});
|
||||||
|
|
||||||
let client = reqwest::Client::default();
|
let client = reqwest::Client::default();
|
||||||
let url = format!("http://{}/", server_addr);
|
let url = format!("http://{}/", server_addr);
|
||||||
@@ -97,7 +96,10 @@ async fn main() -> anyhow::Result<()> {
|
|||||||
.header(MY_DATA_HEADER, serde_json::to_string(&valid_my_data)?)
|
.header(MY_DATA_HEADER, serde_json::to_string(&valid_my_data)?)
|
||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(valid_my_data_response.status(), StatusCode::OK);
|
assert_eq!(
|
||||||
|
valid_my_data_response.status().as_u16(),
|
||||||
|
StatusCode::OK.as_u16()
|
||||||
|
);
|
||||||
|
|
||||||
let invalid_json = String::from("{{}");
|
let invalid_json = String::from("{{}");
|
||||||
let valid_my_data_response = client
|
let valid_my_data_response = client
|
||||||
@@ -105,7 +107,10 @@ async fn main() -> anyhow::Result<()> {
|
|||||||
.header(MY_DATA_HEADER, invalid_json)
|
.header(MY_DATA_HEADER, invalid_json)
|
||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(valid_my_data_response.status(), StatusCode::BAD_REQUEST);
|
assert_eq!(
|
||||||
|
valid_my_data_response.status().as_u16(),
|
||||||
|
StatusCode::BAD_REQUEST.as_u16()
|
||||||
|
);
|
||||||
|
|
||||||
let invalid_my_data = MyData {
|
let invalid_my_data = MyData {
|
||||||
content: String::new(),
|
content: String::new(),
|
||||||
@@ -115,13 +120,16 @@ async fn main() -> anyhow::Result<()> {
|
|||||||
.header(MY_DATA_HEADER, serde_json::to_string(&invalid_my_data)?)
|
.header(MY_DATA_HEADER, serde_json::to_string(&invalid_my_data)?)
|
||||||
.send()
|
.send()
|
||||||
.await?;
|
.await?;
|
||||||
assert_eq!(invalid_my_data_response.status(), VALIDATION_ERROR_STATUS);
|
assert_eq!(
|
||||||
|
invalid_my_data_response.status().as_u16(),
|
||||||
|
VALIDATION_ERROR_STATUS.as_u16()
|
||||||
|
);
|
||||||
// #[cfg(feature = "into_json")]
|
// #[cfg(feature = "into_json")]
|
||||||
// test::check_json(invalid_my_data_response).await;
|
// test::check_json(invalid_my_data_response).await;
|
||||||
println!("Valid<MyData> works.");
|
println!("Valid<MyData> works.");
|
||||||
|
|
||||||
drop(server_guard);
|
// drop(server_guard);
|
||||||
server_handle.await??;
|
// server_handle.await??;
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user