vyuh 0.2.7

Vyuh web framework for Axum and SQLx with handler-first APIs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

//! API key OpenAPI security metadata.
//!
//! Run:
//!
//! ```sh
//! cargo run --example auth_api_key_openapi
//! ```

use schemars::JsonSchema;
use serde::Serialize;
use vyuh::{
    auth::{ApiKey, ApiKeyPrincipal, ApiKeyVerifier, AuthError},
    bundles,
    routes::Json,
};

struct ExampleVerifier;

impl ApiKeyVerifier for ExampleVerifier {
    async fn verify(&self, presented: &str) -> Result<ApiKeyPrincipal, AuthError> {
        if presented == "secret" {
            Ok(ApiKeyPrincipal::new("key-1"))
        } else {
            Err(AuthError::InvalidApiKey)
        }
    }
}

#[derive(Debug, Serialize, JsonSchema)]
struct Accepted {
    ok: bool,
}

#[bundles::route(path = "/events", method = "POST")]
async fn events(_key: ApiKey) -> Json<Accepted> {
    Json(Accepted { ok: true })
}

fn main() {
    let _verifier = ExampleVerifier;
    let bundle = bundles::bundle! {
        events,
    }
    .with_openapi(
        bundles::OpenApiConf::default()
            .title("API Key API")
            .spec("/openapi.json"),
    );

    assert_eq!(bundle.reverse("events", &[]), Some("/events".to_string()));
    println!("api key OpenAPI security metadata registered");
}