aide 0.15.1

A code-first API documentation library
Documentation
use std::{
    marker::PhantomData,
    ops::{Deref, DerefMut},
};

use serde::{Deserialize, Serialize};

use crate::generate::GenContext;
use crate::openapi::{Operation, Response};
use crate::{OperationInput, OperationOutput};

/// Trait that allows implementing a custom Api definition for any type.
///
/// Two approaches are possible:
///
/// 1. Simple Type override for concrete types
/// ```
/// # use aide::{ApiOverride, OperationInput, WithApi};
/// # #[derive(Eq, PartialEq, Debug)] struct SomeType;
///
/// #[derive(Debug)]
/// struct MyApiOverride;
///
/// impl ApiOverride for MyApiOverride {
///     type Target = SomeType;
/// }
///
/// impl OperationInput for MyApiOverride {
///     // override stuff
///     // can be done with OperationOutput as well
/// }
///
/// async fn my_handler(WithApi(ty, ..): WithApi<MyApiOverride>) -> bool {
///     assert_eq!(ty, SomeType);
///     true
/// }
/// ```
///
/// 2. Generic Type Override
/// ```
/// # use std::marker::PhantomData;
/// # use aide::{ApiOverride, OperationInput, WithApi};
/// # #[derive(Eq, PartialEq, Debug)] struct SomeType;
/// # #[derive(Eq, PartialEq, Debug)] struct CustomXML<T>(T);
///
/// #[derive(Debug)]
/// struct MyCustomXML<T>(PhantomData<T>);
///
/// impl<T> ApiOverride for MyCustomXML<T> {
///     type Target = CustomXML<T>;
/// }
///
/// impl<T> OperationInput for MyCustomXML<T> {
///     // override stuff with access to T
///     // can be done with OperationOutput as well
/// }
///
/// async fn my_handler(WithApi(ty, ..): WithApi<MyCustomXML<SomeType>>) -> bool {
///     assert_eq!(ty, CustomXML(SomeType));
///     true
/// }
/// ```
pub trait ApiOverride {
    /// The type that is being overridden
    type Target;
}

/// Allows non [`OperationInput`] or [`OperationOutput`] types to be used in aide handlers with a provided documentation.
///
/// For types that already implement [`OperationInput`] or [`OperationOutput`] it overrides the documentation with the provided one.
/// See [`ApiOverride`] on how to implement such an override
#[derive(Copy, Clone, Debug, Ord, PartialOrd, Eq, PartialEq, Hash, Serialize, Deserialize)]
pub struct WithApi<T>(pub T::Target, pub PhantomData<T>)
where
    T: ApiOverride;

impl<T> WithApi<T>
where
    T: ApiOverride,
{
    /// Unwraps [Self] into its inner type
    pub fn into_inner(self) -> T::Target {
        self.0
    }
}

impl<T> Deref for WithApi<T>
where
    T: ApiOverride,
{
    type Target = T::Target;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl<T> DerefMut for WithApi<T>
where
    T: ApiOverride,
{
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl<T> AsRef<T::Target> for WithApi<T>
where
    T: ApiOverride,
{
    fn as_ref(&self) -> &T::Target {
        &self.0
    }
}

impl<T> AsMut<T::Target> for WithApi<T>
where
    T: ApiOverride,
{
    fn as_mut(&mut self) -> &mut T::Target {
        &mut self.0
    }
}

impl<T> OperationInput for WithApi<T>
where
    T: OperationInput + ApiOverride,
{
    fn operation_input(ctx: &mut GenContext, operation: &mut Operation) {
        T::operation_input(ctx, operation);
    }

    fn inferred_early_responses(
        ctx: &mut GenContext,
        operation: &mut Operation,
    ) -> Vec<(Option<u16>, Response)> {
        T::inferred_early_responses(ctx, operation)
    }
}

impl<T> OperationOutput for WithApi<T>
where
    T: OperationOutput + ApiOverride,
{
    type Inner = T::Inner;

    fn operation_response(ctx: &mut GenContext, operation: &mut Operation) -> Option<Response> {
        T::operation_response(ctx, operation)
    }

    fn inferred_responses(
        ctx: &mut GenContext,
        operation: &mut Operation,
    ) -> Vec<(Option<u16>, Response)> {
        T::inferred_responses(ctx, operation)
    }
}

#[cfg(feature = "axum")]
mod axum {
    use crate::helpers::with_api::ApiOverride;
    use axum::body::Body;
    use axum::extract::{FromRequest, FromRequestParts};
    use axum::response::{IntoResponse, IntoResponseParts, Response, ResponseParts};
    use http::request::Parts;
    use http::Request;

    use crate::WithApi;

    impl<T> IntoResponse for WithApi<T>
    where
        T: ApiOverride,
        T::Target: IntoResponse,
    {
        fn into_response(self) -> Response {
            self.0.into_response()
        }
    }

    impl<T> IntoResponseParts for WithApi<T>
    where
        T: ApiOverride,
        T::Target: IntoResponseParts,
    {
        type Error = <T::Target as IntoResponseParts>::Error;

        fn into_response_parts(self, res: ResponseParts) -> Result<ResponseParts, Self::Error> {
            self.0.into_response_parts(res)
        }
    }

    impl<T, S> FromRequestParts<S> for WithApi<T>
    where
        T: ApiOverride,
        T::Target: FromRequestParts<S>,
        S: Send + Sync,
    {
        type Rejection = <T::Target as FromRequestParts<S>>::Rejection;

        async fn from_request_parts(parts: &mut Parts, state: &S) -> Result<Self, Self::Rejection> {
            Ok(Self(
                <T::Target as FromRequestParts<S>>::from_request_parts(parts, state).await?,
                Default::default(),
            ))
        }
    }

    impl<T, S> FromRequest<S> for WithApi<T>
    where
        T: ApiOverride,
        T::Target: FromRequest<S>,
        S: Send + Sync,
    {
        type Rejection = <T::Target as FromRequest<S>>::Rejection;

        async fn from_request(req: Request<Body>, state: &S) -> Result<Self, Self::Rejection> {
            Ok(Self(
                <T::Target as FromRequest<S>>::from_request(req, state).await?,
                Default::default(),
            ))
        }
    }
}