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

use axum::{extract::FromRequestParts as AxumFromRequestParts, response::IntoResponse as _};
use axum_extra::extract::{Query as AxumQuery, QueryRejection as AxumQueryRejection};
use http::request::Parts;

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

/// Extract data from query strings.
///
/// The type parameter must have an object schema.
/// The schemas for the individual query parameters are then retrieved as the properties of this
/// object schema.
///
/// ### Example
/// ```
/// use autapi::{endpoint::endpoint, request::Query, schema::ToSchema};
///
/// #[derive(ToSchema)]
/// struct UsersQuery {
///     page: i64,
///     /// Requires at least one element
///     user_ids: Vec<i64>,
///     /// Optional list, inner `Vec` will contain at least one element
///     group_ids: Option<Vec<i64>>,
/// }
///
/// #[endpoint(method = GET, path = "/users")]
/// async fn get_users(Query(UsersQuery { page, user_ids, group_ids }): Query<UsersQuery>) {
///     // ...
/// }
/// ```
///
/// ### Axum counterpart
/// This is a slim wrapper around [`axum_extra::extract::Query`].
/// It uses [`SchemaDeserialize`] instead of serde's `Deserialize` and provides OpenAPI integration.
pub struct Query<T>(pub T);

pub struct QueryRejection(AxumQueryRejection);

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

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

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

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

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