refactor: split openapi crate

Author: kwaa

Cargo.toml

@@ -48,6 +48,7 @@ members = [
     "crates/db_migration",
     "crates/db_schema",
     "crates/nodeinfo",
+    "crates/openapi",
     "crates/scheduler",
     "crates/utils",
 ]
@@ -59,6 +60,7 @@ hatsu_apub = { path = "./crates/apub" }
 hatsu_db_migration = { path = "./crates/db_migration" }
 hatsu_db_schema = { path = "./crates/db_schema" }
 hatsu_nodeinfo = { path = "./crates/nodeinfo" }
+hatsu_openapi = { path = "./crates/openapi" }
 hatsu_scheduler = { path = "./crates/scheduler" }
 hatsu_utils = { path = "./crates/utils" }
 activitypub_federation = { version = "0.5", default-features = false, features = ["axum"] }
@@ -104,6 +106,7 @@ hatsu_apub = { workspace = true }
 hatsu_db_migration = { workspace = true }
 hatsu_db_schema = { workspace = true }
 hatsu_nodeinfo = { workspace = true }
+hatsu_openapi = { workspace = true }
 hatsu_scheduler = { workspace = true }
 hatsu_utils = { workspace = true }
 activitypub_federation = { workspace = true }
@@ -124,5 +127,3 @@ tracing-error = { workspace = true }
 tracing-subscriber = { version = "0.3", features = ["env-filter", "json"] }
 url = { workspace = true }
 utoipa = { workspace = true }
-# TODO: dev-dependencies
-utoipa-swagger-ui = { version = "4", features = ["axum"] }

crates/openapi/Cargo.toml

@@ -0,0 +1,24 @@
+[package]
+name = "hatsu_openapi"
+version.workspace = true
+edition.workspace = true
+publish.workspace = true
+readme.workspace = true
+license.workspace = true
+authors.workspace = true
+description.workspace = true
+documentation.workspace = true
+homepage.workspace = true
+repository.workspace = true
+
+[lib]
+name = "hatsu_openapi"
+path = "src/lib.rs"
+
+[dependencies]
+hatsu_api_admin = { workspace = true }
+hatsu_api_mastodon = { workspace = true }
+hatsu_utils = { workspace = true }
+axum = { workspace = true }
+utoipa = { workspace = true }
+utoipa-swagger-ui = { version = "4", features = ["axum"] }

src/routes/openapi.rs renamed to crates/openapi/src/apidoc.rs

@@ -1,14 +1,8 @@
-use axum::{
-    // routing::get,
-    // Json,
-    Router,
-};
 use utoipa::{
     openapi::security::{ApiKey, ApiKeyValue, SecurityScheme},
     Modify,
     OpenApi,
 };
-use utoipa_swagger_ui::SwaggerUi;
 
 #[derive(OpenApi)]
 #[openapi(
@@ -51,9 +45,3 @@ impl Modify for SecurityAddon {
         }
     }
 }
-
-pub fn handler() -> Router {
-    Router::new()
-        // .route("/openapi.json", get(|| async move { Json(ApiDoc::openapi()) }))
-        .merge(SwaggerUi::new("/swagger-ui").url("/openapi.json", ApiDoc::openapi()))
-}

crates/openapi/src/lib.rs

@@ -0,0 +1,12 @@
+use axum::Router;
+use utoipa::OpenApi;
+use utoipa_swagger_ui::SwaggerUi;
+
+mod apidoc;
+pub use apidoc::{ApiDoc, SecurityAddon};
+
+pub fn routes() -> Router {
+    Router::new()
+        // .route("/openapi.json", get(|| async move { Json(ApiDoc::openapi()) }))
+        .merge(SwaggerUi::new("/swagger-ui").url("/openapi.json", ApiDoc::openapi()))
+}

src/routes/mod.rs

@@ -5,8 +5,6 @@ mod objects;
 mod users;
 mod well_known;
 
-mod openapi;
-
 // ./hatsu --version
 async fn root() -> impl IntoResponse {
     let version = env!("CARGO_PKG_VERSION");
@@ -20,10 +18,10 @@ pub fn handler() -> Router {
         .merge(hatsu_api_admin::routes())
         .merge(hatsu_api_mastodon::routes())
         .merge(hatsu_nodeinfo::routes())
+        .merge(hatsu_openapi::routes())
         .merge(activities::handler())
         .merge(objects::handler())
         .merge(users::handler())
         .merge(well_known::handler())
-        .merge(openapi::handler())
         .route("/", get(root))
 }