shield-axum 0.3.1

Axum integration for Shield.
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
53
54
55
56
57
58
59
60

#[cfg(feature = "utoipa")]
use axum::routing::post;
use axum::{
    Router,
    routing::{any, get},
};
use shield::{Shield, User};
#[cfg(feature = "utoipa")]
use utoipa::OpenApi;
#[cfg(feature = "utoipa")]
use utoipa_axum::router::OpenApiRouter;

use crate::routes::*;

#[cfg(feature = "utoipa")]
#[cfg_attr(feature = "utoipa", derive(utoipa::OpenApi))]
#[cfg_attr(feature = "utoipa", openapi(paths(action, forms, user)))]
struct BaseOpenApi;

pub struct AuthRoutes<U: User> {
    #[cfg_attr(not(feature = "utoipa"), expect(dead_code))]
    shield: Shield<U>,
}

impl<U: Clone + User + 'static> AuthRoutes<U> {
    pub fn new(shield: Shield<U>) -> Self {
        Self { shield }
    }

    pub fn router<S: Clone + Send + Sync + 'static>(&self) -> Router<S> {
        Router::new()
            .route("/user", get(user::<U>))
            .route("/forms/{actionId}", get(forms::<U>))
            .route("/{actionId}", any(action::<U>))
            .route("/{actionId}/{methodId}", any(method_action::<U>))
            .route(
                "/{actionId}/{methodId}/{providerId}",
                any(method_action::<U>),
            )
    }

    #[cfg(feature = "utoipa")]
    pub fn openapi_router<S: Clone + Send + Sync + 'static>(&self) -> OpenApiRouter<S> {
        OpenApiRouter::with_openapi(BaseOpenApi::openapi().merge_from(self.shield.openapi()))
            .route("/user", get(user::<U>))
            .route("/forms/{actionId}", get(forms::<U>))
            .route("/{actionId}", get(action::<U>))
            .route("/{actionId}", post(action::<U>))
            .route("/{actionId}/{methodId}", get(method_action::<U>))
            .route("/{actionId}/{methodId}", post(method_action::<U>))
            .route(
                "/{actionId}/{methodId}/{providerId}",
                get(method_action::<U>),
            )
            .route(
                "/{actionId}/{methodId}/{providerId}",
                post(method_action::<U>),
            )
    }
}