rebase + restucture

Cargo.toml

@@ -29,7 +29,7 @@ required-features = [ "backend" ]
 
 [[bin]]
 name = "gen-openapi"
-path = ".cargo/bin/gen_openapi.rs"
+path = "backend/gen_openapi.rs"
 required-features = [ "swagger" ]
 
 [build-dependencies]
@@ -51,22 +51,24 @@ tracing-subscriber = { version = "0.3", optional = true }
 
 ## General
 tokio = { version = "1.0", features = [], optional = true }
+color-eyre = { version = "0.6.2", optional = true }
 
 # CLI
 cli = { path = "./cli", optional = true }
 
 # Backend Lib
 backend = { path = "./backend", optional = true }
 
-color-eyre = {version = "0.6.2", optional = true }
+# OpenAPI
+utoipa = { version = "3.4", features = ["yaml", "axum_extras",  "chrono", "openapi_extensions"], optional = true }
 
 [workspace]
 members = [ "cli", "backend" ]
 
 [features]
 default = [ "frontend", "backend", "swagger" ] 
 frontend = [ "tsync" ]
-swagger = [ "backend/swagger" ]
+swagger = [ "backend/swagger", "utoipa" ]
 backend = [ "axum", "tower", "tower-http" , "tracing", "tracing-subscriber", "tokio", "cli", "dep:backend", "color-eyre" ]
 
 [profile.dev]

api/openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
-  title: bob_management
-  description: Bob Management GUI
+  title: backend
+  description: 'Bob Management GUI: Backend'
   contact:
     name: Romanov Simeon [email protected]
   license:
@@ -11,7 +11,7 @@ paths:
   /:
     get:
       tags:
-      - backend
+      - crate
       operationId: root
       responses:
         '200':

backend/gen_openapi.rs

@@ -0,0 +1,9 @@
+use std::fs;
+use utoipa::OpenApi;
+// in ./src/gen_openapi.rs
+fn main() {
+    let doc = backend::ApiDoc::openapi().to_pretty_json().unwrap();
+    let _ = fs::write("./api/openapi.json", doc);
+    let doc = backend::ApiDoc::openapi().to_yaml().unwrap();
+    let _ = fs::write("./api/openapi.yaml", doc);
+}

backend/src/lib.rs

@@ -24,6 +24,14 @@ pub async fn root() -> &'static str {
     "Hello Bob!"
 }
 
+#[derive(OpenApi)]
+    #[openapi(
+            paths(root),
+            tags(
+                (name = "bob", description = "BOB management API")
+            )
+        )]
+pub struct ApiDoc;
 /// Generate openapi documentation for the project
 #[cfg(feature = "swagger")]
 pub fn openapi_doc() -> Router {
@@ -34,14 +42,7 @@ pub fn openapi_doc() -> Router {
     /* Swagger-only routes */
     #[cfg(debug_assertions)]
     tracing::info!("Generating OpenAPI documentation...");
-    #[derive(OpenApi)]
-    #[openapi(
-            paths(root),
-            tags(
-                (name = "bob", description = "BOB management API")
-            )
-        )]
-    struct ApiDoc;
+
     /* Mount Swagger ui */
     Router::new().merge(SwaggerUi::new("/swagger-ui").url("/api-docs/openapi.json", ApiDoc::openapi()))
         .merge(Redoc::with_url("/redoc", ApiDoc::openapi()))