Add utoipa Swagger UI support (#4602)

* Add utoipa Swagger UI support

* remove unused code

* remove unused code

* consistency with trailing slash

Author: aecsocket

Cargo.lock

@@ -192,6 +192,9 @@ tracing-subscriber = "0.3.20"
 typed-path = "0.12.0"
 url = "2.5.7"
 urlencoding = "2.1.3"
+utoipa = { version = "5.4.0", features = ["actix_extras", "chrono", "decimal"] }
+utoipa-actix-web = { version = "0.1.2" }
+utoipa-swagger-ui = { version = "9.0.2", features = ["actix-web", "vendored"] }
 uuid = "1.18.1"
 validator = "0.20.0"
 webp = { version = "0.3.1", default-features = false }

Cargo.toml

@@ -120,6 +120,9 @@ tracing-ecs = { workspace = true }
 tracing-subscriber = { workspace = true }
 url = { workspace = true }
 urlencoding = { workspace = true }
+utoipa = { workspace = true }
+utoipa-actix-web = { workspace = true }
+utoipa-swagger-ui = { workspace = true }
 uuid = { workspace = true, features = ["fast-rng", "serde", "v4"] }
 validator = { workspace = true, features = ["derive"] }
 webp = { workspace = true }

apps/labrinth/Cargo.toml

@@ -345,6 +345,13 @@ pub fn app_config(
     .default_service(web::get().wrap(default_cors()).to(routes::not_found));
 }
 
+pub fn utoipa_app_config(
+    cfg: &mut utoipa_actix_web::service_config::ServiceConfig,
+    _labrinth_config: LabrinthConfig,
+) {
+    cfg.configure(routes::v3::utoipa_config);
+}
+
 // This is so that env vars not used immediately don't panic at runtime
 pub fn check_env_vars() -> bool {
     let mut failed = false;

apps/labrinth/src/lib.rs

@@ -14,6 +14,7 @@ use labrinth::util::anrok;
 use labrinth::util::env::parse_var;
 use labrinth::util::gotenberg::GotenbergClient;
 use labrinth::util::ratelimit::rate_limit_middleware;
+use labrinth::utoipa_app_config;
 use labrinth::{check_env_vars, clickhouse, database, file_hosting};
 use std::ffi::CStr;
 use std::str::FromStr;
@@ -25,6 +26,9 @@ use tracing_ecs::ECSLayerBuilder;
 use tracing_subscriber::EnvFilter;
 use tracing_subscriber::layer::SubscriberExt;
 use tracing_subscriber::util::SubscriberInitExt;
+use utoipa::OpenApi;
+use utoipa_actix_web::AppExt;
+use utoipa_swagger_ui::SwaggerUi;
 
 #[cfg(target_os = "linux")]
 #[global_allocator]
@@ -293,13 +297,23 @@ async fn main() -> std::io::Result<()> {
             .wrap(from_fn(rate_limit_middleware))
             .wrap(actix_web::middleware::Compress::default())
             .wrap(sentry_actix::Sentry::new())
+            .into_utoipa_app()
+            .configure(|cfg| utoipa_app_config(cfg, labrinth_config.clone()))
+            .openapi_service(|api| SwaggerUi::new("/docs/swagger-ui/{_:.*}")
+                .config(utoipa_swagger_ui::Config::default().try_it_out_enabled(true))
+                .url("/docs/openapi.json", ApiDoc::openapi().merge_from(api)))
+            .into_app()
             .configure(|cfg| app_config(cfg, labrinth_config.clone()))
     })
     .bind(dotenvy::var("BIND_ADDR").unwrap())?
     .run()
     .await
 }
 
+#[derive(utoipa::OpenApi)]
+#[openapi(info(title = "Labrinth"))]
+struct ApiDoc;
+
 fn log_error(err: &actix_web::Error) {
     if err.as_response_error().status_code().is_client_error() {
         tracing::debug!(

apps/labrinth/src/main.rs

@@ -77,12 +77,8 @@ pub fn root_config(cfg: &mut web::ServiceConfig) {
             }.boxed_local()
         })
     );
-    cfg.service(
-        web::scope("")
-            .wrap(default_cors())
-            .service(index::index_get)
-            .service(Files::new("/", "assets/")),
-    );
+    cfg.service(index::index_get);
+    cfg.service(Files::new("/", "assets/"));
 }
 
 #[derive(thiserror::Error, Debug)]