chore: fix openapi spec generation

Signed-off-by: Henry <mail@henrygressmann.de>

Author: explodingcamera

Cargo.lock

@@ -58,7 +58,7 @@ tower-http={version="0.6", default-features=false, features=[
     "set-header",
 ]}
 tower_governor={version="0.8", default-features=false, features=["axum"]}
-aide={version="0.16.0-alpha.1", default-features=false, features=[
+aide={version="0.16.0-alpha.2", default-features=false, features=[
     "axum",
     "axum-json",
     "axum-query",
@@ -72,7 +72,7 @@ aide={version="0.16.0-alpha.1", default-features=false, features=[
 schemars={version="1.2", features=["derive", "chrono04"]}
 
 ua-parser="0.2"
-rust-embed={version="8.9", features=["mime-guess"]}
+rust-embed={version="8.11", features=["mime-guess"]}
 reqwest={version="0.13", default-features=false, features=["json", "stream", "charset", "rustls"]}
 
 # database

Cargo.toml

@@ -46,7 +46,7 @@ impl Deref for RouterState {
     }
 }
 
-pub fn router(app: Arc<Liwan>, events: Sender<Event>) -> Result<axum::Router<()>> {
+pub fn router(app: Arc<Liwan>, events: Sender<Event>) -> Result<(axum::Router<()>, openapi::OpenApi)> {
     let mut api = openapi::OpenApi {
         info: openapi::Info { title: "Liwan API".to_string(), ..Default::default() },
         ..openapi::OpenApi::default()
@@ -89,7 +89,30 @@ pub fn router(app: Arc<Liwan>, events: Sender<Event>) -> Result<axum::Router<()>
         .with_state(RouterState { app: app.clone(), events })
         .finish_api(&mut api);
 
-    Ok(router)
+    Ok((router, api))
+}
+
+#[cfg(debug_assertions)]
+fn save_spec(spec: openapi::OpenApi) -> Result<()> {
+    use std::path::Path;
+
+    let path = Path::new("./web/src/api/dashboard.ts");
+    if path.exists() {
+        let spec = serde_json::to_string(&spec)?
+            .replace(r#""servers":[],"#, "") // fets doesn't work with an empty servers array
+            .replace("; charset=utf-8", "") // fets doesn't detect the json content type correctly
+            .replace(r#""format":"int64","#, ""); // fets uses bigint for int64
+
+        // check if the spec has changed
+        let old_spec = std::fs::read_to_string(path)?;
+        if old_spec == format!("export default {spec} as const;\n") {
+            return Ok(());
+        }
+
+        tracing::info!("API has changed, updating the openapi spec...");
+        std::fs::write(path, format!("export default {spec} as const;\n"))?;
+    }
+    Ok(())
 }
 
 pub async fn start_webserver(app: Arc<Liwan>, events: Sender<Event>) -> Result<()> {
@@ -106,7 +129,11 @@ pub async fn start_webserver(app: Arc<Liwan>, events: Sender<Event>) -> Result<(
     }
 
     let router = router(app.clone(), events)?;
+
+    #[cfg(debug_assertions)]
+    save_spec(router.1)?;
+
     let listener = tokio::net::TcpListener::bind(("0.0.0.0", app.config.port)).await.unwrap();
-    let service = router.into_make_service_with_connect_info::<SocketAddr>();
+    let service = router.0.into_make_service_with_connect_info::<SocketAddr>();
     axum::serve(listener, service).await.context("server exited unexpectedly")
 }

src/web/mod.rs

@@ -1,4 +1,7 @@
-use aide::axum::{ApiRouter, IntoApiResponse, routing::*};
+use aide::{
+    UseApi,
+    axum::{ApiRouter, IntoApiResponse, routing::*},
+};
 use axum::{
     Json,
     extract::{Path, State},
@@ -147,7 +150,10 @@ struct EntitiesResponse {
     entities: Vec<EntityResponse>,
 }
 
-async fn get_users(app: State<RouterState>, SessionUser(user): SessionUser) -> ApiResult<impl IntoApiResponse> {
+async fn get_users(
+    app: State<RouterState>,
+    SessionUser(user): SessionUser,
+) -> ApiResult<UseApi<impl IntoApiResponse, Json<UsersResponse>>> {
     if user.role != UserRole::Admin {
         http_bail!(StatusCode::FORBIDDEN, "Forbidden")
     }
@@ -160,7 +166,7 @@ async fn get_users(app: State<RouterState>, SessionUser(user): SessionUser) -> A
         .map(|u| UserResponse { username: u.username.clone(), role: u.role, projects: u.projects.clone() })
         .collect();
 
-    Ok(([(http::header::CACHE_CONTROL, "private")], Json(UsersResponse { users })))
+    Ok(([(http::header::CACHE_CONTROL, "private")], Json(UsersResponse { users })).into())
 }
 
 async fn update_user(
@@ -295,7 +301,7 @@ async fn project_update_handler(
 async fn projects_handler(
     app: State<RouterState>,
     MaybeExtract(user): MaybeExtract<SessionUser>,
-) -> ApiResult<impl IntoApiResponse> {
+) -> ApiResult<UseApi<impl IntoApiResponse, Json<ProjectsResponse>>> {
     let projects = app.projects.all().http_err("Failed to get projects", StatusCode::INTERNAL_SERVER_ERROR)?;
     let projects: Vec<Project> = projects.into_iter().filter(|p| can_access_project(p, user.as_ref())).collect();
 
@@ -315,14 +321,14 @@ async fn projects_handler(
         });
     }
 
-    Ok(([(http::header::CACHE_CONTROL, "private")], Json(ProjectsResponse { projects: resp })))
+    Ok(([(http::header::CACHE_CONTROL, "private")], Json(ProjectsResponse { projects: resp })).into())
 }
 
 async fn project_handler(
     app: State<RouterState>,
     MaybeExtract(user): MaybeExtract<SessionUser>,
     Path(project_id): Path<String>,
-) -> ApiResult<impl IntoApiResponse> {
+) -> ApiResult<UseApi<impl IntoApiResponse, Json<ProjectResponse>>> {
     let project = app.projects.get(&project_id).http_status(StatusCode::NOT_FOUND)?;
     if !can_access_project(&project, user.as_ref()) {
         return Err(StatusCode::NOT_FOUND.into());
@@ -341,7 +347,7 @@ async fn project_handler(
         public: project.public,
     });
 
-    Ok(([(http::header::CACHE_CONTROL, "private")], resp))
+    Ok(([(http::header::CACHE_CONTROL, "private")], resp).into())
 }
 
 async fn project_delete_handler(
@@ -358,7 +364,10 @@ async fn project_delete_handler(
     Ok(empty_response())
 }
 
-async fn entities_handler(app: State<RouterState>, SessionUser(user): SessionUser) -> ApiResult<impl IntoApiResponse> {
+async fn entities_handler(
+    app: State<RouterState>,
+    SessionUser(user): SessionUser,
+) -> ApiResult<UseApi<impl IntoApiResponse, Json<EntitiesResponse>>> {
     if user.role != UserRole::Admin {
         http_bail!(StatusCode::FORBIDDEN, "Forbidden")
     }
@@ -384,7 +393,7 @@ async fn entities_handler(app: State<RouterState>, SessionUser(user): SessionUse
         });
     }
 
-    Ok(([(http::header::CACHE_CONTROL, "private")], Json(EntitiesResponse { entities: resp })))
+    Ok(([(http::header::CACHE_CONTROL, "private")], Json(EntitiesResponse { entities: resp })).into())
 }
 
 async fn entity_create_handler(

src/web/routes/admin.rs

@@ -1,4 +1,7 @@
-use aide::axum::{ApiRouter, IntoApiResponse, routing::*};
+use aide::{
+    UseApi,
+    axum::{ApiRouter, IntoApiResponse, routing::*},
+};
 use anyhow::Context;
 use axum::{Json, extract::State};
 use axum_extra::extract::CookieJar;
@@ -58,8 +61,8 @@ pub struct MeResponse {
     pub role: UserRole,
 }
 
-async fn me(SessionUser(user): SessionUser) -> impl IntoApiResponse {
-    ([(header::CACHE_CONTROL, "private")], Json(MeResponse { username: user.username, role: user.role }))
+async fn me(SessionUser(user): SessionUser) -> UseApi<impl IntoApiResponse, Json<MeResponse>> {
+    ([(header::CACHE_CONTROL, "private")], Json(MeResponse { username: user.username, role: user.role })).into()
 }
 
 async fn setup(app: State<RouterState>, Json(params): Json<SetupRequest>) -> ApiResult<impl IntoApiResponse> {

src/web/routes/auth.rs

@@ -9,7 +9,7 @@ use std::task::{Context, Poll};
 
 use crate::web::Files;
 use aide::axum::IntoApiResponse;
-use aide::{OperationIo, OperationOutput};
+use aide::{OperationInput, OperationOutput};
 use axum::body::Body;
 use axum::extract::{ConnectInfo, FromRequestParts, Request};
 use axum::response::IntoResponse;
@@ -209,8 +209,9 @@ macro_rules! http_bail {
 }
 pub(crate) use http_bail;
 
-#[derive(Debug, Copy, Clone, OperationIo)]
+#[derive(Debug, Copy, Clone)]
 pub struct ClientIp(pub Option<IpAddr>);
+impl OperationInput for ClientIp {}
 
 impl<S: Send + Sync> FromRequestParts<S> for ClientIp {
     type Rejection = Infallible;

src/web/webext.rs

@@ -23,7 +23,7 @@ pub struct TestClient {
 
 impl TestClient {
     pub fn new(app: Arc<Liwan>, events: std::sync::mpsc::Sender<Event>) -> Self {
-        let router = liwan::web::router(app, events).unwrap();
+        let (router, _) = liwan::web::router(app, events).unwrap();
         let server = TestServer::new(router).unwrap();
         Self { server }
     }

tests/common/mod.rs

@@ -17,7 +17,7 @@
 		"@radix-ui/react-accordion": "^1.2.12",
 		"@radix-ui/react-dialog": "^1.1.15",
 		"@radix-ui/react-tabs": "^1.1.13",
-		"@tanstack/react-query": "^5.90.16",
+		"@tanstack/react-query": "^5.90.18",
 		"d3-array": "^3.2.4",
 		"d3-axis": "^3.0.0",
 		"d3-ease": "^3.0.1",
@@ -41,25 +41,25 @@
 	"devDependencies": {
 		"@astrojs/check": "^0.9.6",
 		"@biomejs/biome": "2.3.11",
-		"@types/bun": "^1.3.5",
+		"@types/bun": "^1.3.6",
 		"@types/d3-array": "^3.2.2",
 		"@types/d3-axis": "^3.0.6",
 		"@types/d3-ease": "^3.0.2",
 		"@types/d3-geo": "^3.1.0",
 		"@types/d3-scale": "^4.0.9",
 		"@types/d3-selection": "^3.0.11",
-		"@types/d3-shape": "^3.1.7",
+		"@types/d3-shape": "^3.1.8",
 		"@types/d3-transition": "^3.0.9",
 		"@types/d3-zoom": "^3.0.8",
 		"@types/react": "^19.2.8",
 		"@types/react-dom": "^19.2.3",
 		"@types/topojson-client": "^3.1.5",
 		"@types/topojson-specification": "^1.0.5",
-		"astro": "5.16.8",
+		"astro": "5.16.11",
 		"rollup-plugin-license": "^3.6.0",
 		"typescript": "^5.9.3"
 	},
-	"packageManager": "bun@1.3.5",
+	"packageManager": "bun@1.3.6",
 	"trustedDependencies": [
 		"@biomejs/biome",
 		"esbuild"