lenso-platform-http 0.1.21

HTTP primitives for the Lenso backend framework.
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

use crate::health::{livez, readyz};
use axum::Router;
use axum::routing::get;
use platform_core::AppContext;
use utoipa_axum::router::OpenApiRouter;

/// Axum router specialized to the shared [`AppContext`] state.
pub type ApiRouter = Router<AppContext>;

/// `OpenAPI`-aware router specialized to the shared [`AppContext`] state.
///
/// Domains and apps build these so that HTTP routes and their `OpenAPI`
/// documentation come from a single `#[utoipa::path]`-annotated handler.
pub type ApiOpenApiRouter = OpenApiRouter<AppContext>;

/// Base router with liveness/readiness probes.
///
/// These probes are intentionally excluded from the `OpenAPI` contract, so they
/// are registered as plain routes rather than documented paths.
pub fn base_router() -> ApiOpenApiRouter {
    OpenApiRouter::new()
        .route("/livez", get(livez))
        .route("/readyz", get(readyz))
}