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
65
66
67
68
69
70
71
72
73
74

use axum::{
    extract::{
        FromRequestParts as AxumFromRequestParts, Path as AxumPath,
        rejection::PathRejection as AxumPathRejection,
    },
    response::IntoResponse as _,
};
use http::request::Parts;

use crate::{
    Registry,
    adapters::SerdeAdapter,
    openapi::{Operation, ParameterIn, Responses},
    request::{FromRequestParts, utils::add_parameters_to_operation},
    response::IntoResponse,
    schema::SchemaDeserialize,
};

/// Extract segments from the path of the requested URL.
///
/// The type parameter must have an object schema.
/// The schemas for the individual path segments are then retrieved as the properties of this object
/// schema.
///
/// ### Example
/// ```
/// use autapi::{endpoint::endpoint, request::Path, schema::ToSchema};
///
/// #[derive(ToSchema)]
/// struct UsersPath {
///     user_id: i64,
/// }
///
/// #[endpoint(method = GET, path = "/users/{user_id}")]
/// async fn get_user(Path(UsersPath { user_id }): Path<UsersPath>) {
///     // ...
/// }
/// ```
///
/// ### Axum counterpart
/// This is a slim wrapper around [`axum::extract::Path`].
/// It uses [`SchemaDeserialize`] instead of serde's `Deserialize` and provides OpenAPI integration.
pub struct Path<T>(pub T);

pub struct PathRejection(AxumPathRejection);

impl<T, S> FromRequestParts<S> for Path<T>
where
    T: SchemaDeserialize + Send,
    S: Send + Sync + 'static,
{
    type Rejection = PathRejection;

    fn openapi(operation: &mut Operation, registry: &mut Registry) {
        add_parameters_to_operation::<T>(operation, registry, ParameterIn::Path, "path");
    }

    async fn from_request_parts(parts: &mut Parts, state: &S) -> Result<Self, Self::Rejection> {
        <AxumPath<SerdeAdapter<T>> as AxumFromRequestParts<S>>::from_request_parts(parts, state)
            .await
            .map(|query| Self(query.0.0))
            .map_err(PathRejection)
    }
}

impl IntoResponse for PathRejection {
    fn openapi(_: &mut Registry) -> Responses {
        Responses::default()
    }

    fn into_response(self) -> crate::response::Response {
        self.0.into_response()
    }
}