Add OpenAPI support and health info endpoint documentation

apps/api/Cargo.toml

@@ -20,3 +20,4 @@ serde = { version = "1.0.228", features = ["std", "derive"] }
 sea-orm = { workspace = true }
 include_dir = { version = "0.7.4" }
 mime_guess = { version = "2.0.5" }
+utoipa = { version = "5.4.0", features = ["macros", "axum_extras", "chrono", "decimal", "uuid", "time", "openapi_extensions"] }

apps/api/src/routes.rs

@@ -1,6 +1,8 @@
 mod api;
 mod view;
 
+pub use self::api::ApiDoc;
+
 use std::sync::Arc;
 
 use axum::{Extension, Router};

apps/api/src/routes/api.rs

@@ -1,4 +1,7 @@
 mod health;
+mod openapi;
+
+pub use self::openapi::ApiDoc;
 
 use axum::{Router, response::IntoResponse, routing::any};
 

apps/api/src/routes/api/health.rs

@@ -1,4 +1,4 @@
-mod info;
+pub mod info;
 mod state;
 
 use std::sync::Arc;

apps/api/src/routes/api/health/info.rs

@@ -9,7 +9,7 @@ use crate::routes::api::health::state::HealthState;
 const STATUS_HEALTHY: &str = "healthy";
 const STATUS_UNHEALTHY: &str = "unhealthy";
 
-#[derive(Serialize, Deserialize)]
+#[derive(Serialize, Deserialize, utoipa::ToSchema)]
 pub struct HealthInfo {
     pub status: String,
     pub version: String,
@@ -18,6 +18,17 @@ pub struct HealthInfo {
     pub errors: Option<Vec<String>>,
 }
 
+#[utoipa::path(
+        get,
+        path = "/api/health/info",
+        responses(
+            (status = 200, description = "Health information retrieved successfully", body = HealthInfo),
+            (status = NOT_FOUND, description = "Health information not found")
+        ),
+        params(
+            ("id" = u64, Path, description = "Pet database id to get Pet for"),
+        )
+    )]
 pub async fn get_health_info(
     State(state): State<Arc<HealthState>>,
 ) -> (StatusCode, Json<HealthInfo>) {

apps/api/src/routes/api/openapi.rs

@@ -0,0 +1,3 @@
+#[derive(utoipa::OpenApi)]
+#[openapi(paths(crate::routes::api::health::info::get_health_info))]
+pub struct ApiDoc;