flatbed 0.0.5

Rust HTTP framework with FlatBuffer codegen, built on Hyper
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

//! Built-in endpoints for telemetry and OpenAPI
//!
//! These endpoints are automatically registered when the corresponding features are enabled.

use crate::{ResponseParts, StatusCode};

#[cfg(feature = "openapi")]
use crate::FlatbedConfig;

#[cfg(feature = "openapi")]
use crate::{get_latest_version, get_openapi_json_for_version, get_route_versions};

/// Build a health check response
pub fn health_response() -> ResponseParts {
    ResponseParts {
        body: b"OK".to_vec(),
        status: StatusCode::OK,
        headers: crate::HeaderMap::new(),
        content_type: "text/plain".into(),
    }
}

/// Build a readiness response
pub fn ready_response() -> ResponseParts {
    ResponseParts {
        body: b"Ready".to_vec(),
        status: StatusCode::OK,
        headers: crate::HeaderMap::new(),
        content_type: "text/plain".into(),
    }
}

/// Build a metrics response
#[cfg(feature = "telemetry")]
pub fn metrics_response(metrics: String) -> ResponseParts {
    ResponseParts {
        body: metrics.into_bytes(),
        status: StatusCode::OK,
        headers: crate::HeaderMap::new(),
        content_type: "text/plain; version=0.0.4; charset=utf-8".into(),
    }
}

/// Build an OpenAPI spec response
#[cfg(feature = "openapi")]
pub fn openapi_response(config: &FlatbedConfig, version: Option<&str>) -> ResponseParts {
    let latest = get_latest_version();
    let version = version.unwrap_or(&latest);
    let json = get_openapi_json_for_version(config, version);

    ResponseParts {
        body: json.into_bytes(),
        status: StatusCode::OK,
        headers: crate::HeaderMap::new(),
        content_type: "application/json".into(),
    }
}

/// Check if a path is a telemetry endpoint
#[cfg(feature = "telemetry")]
pub fn is_telemetry_endpoint(path: &str) -> bool {
    matches!(path, "/healthz" | "/readyz" | "/metrics")
}

/// Check if a path is an OpenAPI endpoint
#[cfg(feature = "openapi")]
pub fn is_openapi_endpoint(path: &str) -> bool {
    if path == "/openapi.json" {
        return true;
    }

    // Check versioned endpoints
    for version in get_route_versions() {
        if path == format!("/{}/openapi.json", version) {
            return true;
        }
    }

    false
}

/// Extract version from OpenAPI endpoint path
#[cfg(feature = "openapi")]
pub fn extract_openapi_version(path: &str) -> Option<String> {
    if path == "/openapi.json" {
        return Some(get_latest_version());
    }

    // Match /v{version}/openapi.json
    get_route_versions()
        .into_iter()
        .find(|version| path == format!("/{}/openapi.json", version))
}