Utoipa migration (#139)

* migrate from okapi to utoipa since its better maintained

backend/Cargo.toml

@@ -13,8 +13,11 @@ anyhow = "1.0.94"
 reqwest = { version = "0.12.9", features = ["blocking", "gzip"] }
 
 rocket = "0.5.1"
-rocket_okapi = { version = "0.9.0", features = ["swagger"] }
 rocket_oauth2 = "0.5.0"
+utoipa = { version = "5.3.1", features = ["rocket_extras"] }
+utoipa-redoc = { version = "5.0.1", features = ["rocket"] }
+utoipa-scalar = { version = "0.2.1", features = ["rocket"] }
+
 dotenvy = "0.15.7"
 sea-orm = { version = "1.1.2", features = [ "sqlx-sqlite", "sqlx-postgres", "runtime-tokio-rustls", "macros", "with-bigdecimal" ] }
 sea-orm-migration = {version = "1.1.2", features = ["sqlx-sqlite", "runtime-tokio-rustls"]}

backend/src/api/aur.rs

@@ -1,13 +1,23 @@
 use crate::aur::api::query_aur;
 use rocket::serde::json::Json;
 
-use rocket::get;
-
 use crate::api::types::authenticated::Authenticated;
 use crate::api::types::input::ApiPackage;
-use rocket_okapi::openapi;
+use rocket::get;
+use utoipa::OpenApi;
+
+#[derive(OpenApi)]
+#[openapi(paths(search))]
+pub struct AURApi;
 
-#[openapi(tag = "aur")]
+#[utoipa::path(
+    responses(
+            (status = 200, description = "Get all todos", body = [ApiPackage]),
+    ),
+    params(
+        ("query", description = "AUR query"),
+    )
+)]
 #[get("/search?<query>")]
 pub async fn search(query: &str, _a: Authenticated) -> Result<Json<Vec<ApiPackage>>, String> {
     if query.len() < 2 {

backend/src/api/auth.rs

@@ -3,12 +3,27 @@ use rocket::get;
 use rocket::http::{Cookie, CookieJar, SameSite};
 use rocket::response::Redirect;
 use rocket_oauth2::{OAuth2, TokenResponse};
+use utoipa::OpenApi;
 
+#[derive(OpenApi)]
+#[openapi(paths(oauth_login, oauth_callback))]
+pub struct AuthApi;
+
+#[utoipa::path(
+    responses(
+            (status = 200, description = "Redirect to oidc login endpoint"),
+    )
+)]
 #[get("/login")]
 pub fn oauth_login(oauth2: OAuth2<()>, cookies: &CookieJar<'_>) -> Redirect {
     oauth2.get_redirect(cookies, &["user:email"]).unwrap()
 }
 
+#[utoipa::path(
+    responses(
+            (status = 200, description = "Oauth callback (called by oidc provider)"),
+    )
+)]
 #[get("/auth")]
 pub fn oauth_callback(token: TokenResponse<()>, cookies: &CookieJar<'_>) -> Redirect {
     debug!("Token: {:?}", token);

backend/src/api/backend.rs

@@ -3,11 +3,10 @@ use crate::api::build::*;
 use crate::api::health::*;
 use crate::api::package::*;
 use crate::api::stats::*;
-use rocket::Route;
-use rocket_okapi::openapi_get_routes;
+use rocket::{routes, Route};
 
 pub fn build_api() -> Vec<Route> {
-    openapi_get_routes![
+    routes![
         search,
         package_list,
         package_add_endpoint,