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
|
mod routes;
use axum::{Router, response::IntoResponse};
use utoipa::OpenApi;
use utoipa_axum::router::OpenApiRouter;
#[cfg(feature = "redoc")]
use utoipa_redoc::Servable;
#[cfg(feature = "scalar")]
use utoipa_scalar::Servable as _;
use crate::state::AppHandle;
const TAG_ROUTING: &str = "Routing";
#[derive(OpenApi)]
#[openapi(
tags(
(name = TAG_ROUTING, description = "Operations related to routing configuration"),
)
)]
pub struct ApiDoc;
/// Get health of the API.
#[utoipa::path(
method(get),
path = "/",
responses(
(status = OK, description = "Success", body = str, content_type = "text/plain")
)
)]
pub async fn health_check() -> impl IntoResponse {
let name = env!("CARGO_PKG_NAME");
let ver = env!("CARGO_PKG_VERSION");
format!("{name} v{ver} is live")
}
pub fn build_router(state: AppHandle) -> Router {
let (router, _api) = OpenApiRouter::with_openapi(ApiDoc::openapi())
.routes(utoipa_axum::routes!(health_check))
.nest("/api", routes::router(state))
.split_for_parts();
#[cfg(feature = "swagger")]
let router = router.merge(
utoipa_swagger_ui::SwaggerUi::new("/swagger-ui")
.url("/api-docs/swaggerdoc.json", _api.clone()),
);
#[cfg(feature = "redoc")]
let router = router.merge(utoipa_redoc::Redoc::with_url("/redoc", _api.clone()));
#[cfg(feature = "rapidoc")]
let router = router.merge(
utoipa_rapidoc::RapiDoc::with_openapi("/api-docs/rapidoc.json", _api.clone())
.path("/rapidoc"),
);
#[cfg(feature = "scalar")]
let router = router.merge(utoipa_scalar::Scalar::with_url("/scalar", _api));
warden_middleware::apply(router)
}
|
