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

mod json;
mod status_codes;
mod text;
mod undocumented;

use std::convert::Infallible;

pub use self::{json::*, status_codes::*, text::*};
use crate::{Registry, openapi::Responses};

pub type Response = axum::response::Response;

/// A type that is convertible to an HTTP response with OpenAPI description.
///
/// Most notably, this trait is implemented for
/// - `T: ToSchema + SchemaSerialize`, returning a `200 Ok` response with
///   `Content-Type: application/json`
/// - `Result<T, E>` with `T: IntoResponse` and `E: IntoResponse`
/// - The new-type structs in this module named after status codes (e.g. [`Created`])
pub trait IntoResponse {
    /// Describes the responses generated via the [`into_response`](Self::into_response) function.
    fn openapi(registry: &mut Registry) -> Responses;
    /// Converts this value into an axum response.
    fn into_response(self) -> Response;
}

impl<T: IntoResponse, E: IntoResponse> IntoResponse for Result<T, E> {
    fn openapi(registry: &mut Registry) -> Responses {
        let mut responses = T::openapi(registry);
        responses.merge_with(E::openapi(registry));
        responses
    }

    fn into_response(self) -> Response {
        match self {
            Self::Ok(t) => t.into_response(),
            Self::Err(e) => e.into_response(),
        }
    }
}

impl IntoResponse for Infallible {
    fn openapi(_: &mut Registry) -> Responses {
        Default::default()
    }
    fn into_response(self) -> Response {
        match self {}
    }
}