tako-rs 1.1.1

Multi-transport Rust framework for modern network services.
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
75

//! Utoipa OpenAPI integration for Tako.
//!
//! This module provides integration with the utoipa crate for generating
//! OpenAPI documentation from Tako routes and handlers.
//!
//! Enable via the `utoipa` cargo feature.
#![cfg(feature = "utoipa")]
#![cfg_attr(docsrs, doc(cfg(feature = "utoipa")))]

use http::StatusCode;
pub use utoipa::Modify;
pub use utoipa::OpenApi;
pub use utoipa::ToResponse;
pub use utoipa::ToSchema;
pub use utoipa::openapi;

use crate::body::TakoBody;
use crate::responder::Responder;
use crate::types::Response;

/// Serves the OpenAPI JSON specification.
///
/// # Examples
///
/// ```rust,ignore
/// use tako::openapi::utoipa::{OpenApi, OpenApiJson};
///
/// #[derive(OpenApi)]
/// #[openapi(paths(health), components(schemas(HealthResponse)))]
/// struct ApiDoc;
///
/// async fn openapi_handler(_req: tako::types::Request) -> OpenApiJson {
///     OpenApiJson(ApiDoc::openapi())
/// }
/// ```
pub struct OpenApiJson(pub openapi::OpenApi);

impl Responder for OpenApiJson {
  fn into_response(self) -> Response {
    match serde_json::to_vec(&self.0) {
      Ok(buf) => {
        let mut res = Response::new(TakoBody::from(buf));
        res.headers_mut().insert(
          http::header::CONTENT_TYPE,
          http::HeaderValue::from_static("application/json"),
        );
        res
      }
      Err(err) => (StatusCode::INTERNAL_SERVER_ERROR, err.to_string()).into_response(),
    }
  }
}

/// Serves the OpenAPI YAML specification.
///
/// Requires the `utoipa-yaml` feature to be enabled.
#[cfg(feature = "utoipa-yaml")]
pub struct OpenApiYaml(pub openapi::OpenApi);

#[cfg(feature = "utoipa-yaml")]
impl Responder for OpenApiYaml {
  fn into_response(self) -> Response {
    match self.0.to_yaml() {
      Ok(yaml) => {
        let mut res = Response::new(TakoBody::from(yaml));
        res.headers_mut().insert(
          http::header::CONTENT_TYPE,
          http::HeaderValue::from_static("application/x-yaml"),
        );
        res
      }
      Err(err) => (StatusCode::INTERNAL_SERVER_ERROR, err.to_string()).into_response(),
    }
  }
}