autapi 0.0.1

Automatic OpenAPI specification from function signatures
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
61
62
63
64

mod json;
mod state;
mod undocumented;
mod utils;

mod path;
pub use path::{Path, PathRejection};

#[cfg(feature = "query")]
mod query;
#[cfg(feature = "query")]
pub use query::{Query, QueryRejection};

pub use self::state::State;

use http::request::Parts;

use crate::{Registry, openapi::Operation, response::IntoResponse};

pub type Request = axum::extract::Request;

/// Data that can be derived from a request.
pub trait FromRequest<S, V = via::Request>: Sized {
    type Rejection: IntoResponse;

    fn openapi(operation: &mut Operation, registry: &mut Registry);
    fn from_request(
        request: Request,
        state: &S,
    ) -> impl Future<Output = Result<Self, Self::Rejection>> + Send;
}

/// Data that can be derived from request parts.
pub trait FromRequestParts<S>: Sized {
    type Rejection: IntoResponse;

    fn openapi(operation: &mut Operation, registry: &mut Registry);
    fn from_request_parts(
        parts: &mut Parts,
        state: &S,
    ) -> impl Future<Output = Result<Self, Self::Rejection>> + Send;
}

impl<S, T> FromRequest<S, via::Parts> for T
where
    T: FromRequestParts<S>,
    S: Send + Sync,
{
    type Rejection = T::Rejection;

    fn openapi(operation: &mut Operation, registry: &mut Registry) {
        T::openapi(operation, registry);
    }

    async fn from_request(request: Request, state: &S) -> Result<Self, Self::Rejection> {
        let mut parts = request.into_parts().0;
        T::from_request_parts(&mut parts, state).await
    }
}

mod via {
    pub enum Parts {}
    pub enum Request {}
}