feat: openapi

httpw/Cargo.toml

@@ -15,3 +15,5 @@ serde_json = { version = "1.0.93" }
 tracing = { version = "0.1.37" }
 opentelemetry = { version = "0.18.0" }
 actix-web-opentelemetry = { version = "0.13.0", features = ["metrics"] }
+utoipa = { version = "3.0.2", features = ["actix_extras"] }
+utoipa-swagger-ui = { version = "3.0.2", features = ["actix-web"] }

httpw/src/server/server.rs

@@ -1,6 +1,7 @@
 use super::types::RouteConfig;
 use crate::{errors::HttpServerError, middlewares};
 use actix_web::{
+    http::KeepAlive,
     middleware as actix_middleware,
     web::{self, Data},
     App, HttpResponse, HttpServer, Responder,
@@ -9,14 +10,16 @@ use actix_web_opentelemetry::{RequestMetricsBuilder, RequestTracing};
 use auth::jwt_manager::JwtManager;
 use env::AppConfig;
 use opentelemetry::global;
-use std::sync::Arc;
+use std::{sync::Arc, time::Duration};
 use tracing::error;
+use utoipa::openapi::OpenApi;
+use utoipa_swagger_ui::SwaggerUi;
 
 pub struct HttpwServerImpl {
     services: Vec<RouteConfig>,
     jwt_manager: Option<Arc<dyn JwtManager + Send + Sync>>,
     addr: String,
-    // openapi_file_path: Option<String>,
+    openapi: Option<OpenApi>,
 }
 
 impl HttpwServerImpl {
@@ -25,7 +28,7 @@ impl HttpwServerImpl {
             services: vec![],
             addr: cfg.app_addr(),
             jwt_manager: None,
-            // openapi_file_path: None,
+            openapi: None,
         }
     }
 }
@@ -41,16 +44,16 @@ impl HttpwServerImpl {
         self
     }
 
-    // pub fn openapi_file_path(mut self, file_path: String) -> Self {
-    //     self.openapi_file_path = Some(file_path);
-    //     self
-    // }
+    pub fn openapi(mut self, openapi: &OpenApi) -> Self {
+        self.openapi = Some(openapi.to_owned());
+        self
+    }
 
     pub async fn start(&self) -> Result<(), HttpServerError> {
         HttpServer::new({
             let services = self.services.to_vec();
             let jwt_manager = self.jwt_manager.clone();
-            // let openapi_file = self.openapi_file_path.clone();
+            let openapi = self.openapi.clone();
 
             move || {
                 let meter = global::meter("actix_web");
@@ -74,22 +77,20 @@ impl HttpwServerImpl {
                     app = app.configure(svc);
                 }
 
-                // if let Some(_openapi) = openapi_file.clone() {
-                // let spec = swagger_ui::swagger_spec_file!("../../swagger-ui/examples/openapi.json");
-                // let config = swagger_ui::Config::default();
-                //
-                // let app =  app.service(
-                //   scope("/v1/doc")
-                //     .configure(actix_web_swagger_ui::swagger(spec, config))
-                // );
-                //
-                // }
+                if openapi.is_some() {
+                    app = app.service(
+                        SwaggerUi::new("/docs/{_:.*}")
+                            .url("/docs/openapi.json", openapi.clone().unwrap()),
+                    );
+                }
 
                 app.route("/health", web::get().to(health_handler))
                     .default_service(web::to(middlewares::not_found::not_found))
                     .wrap(actix_middleware::Logger::default())
             }
         })
+        .shutdown_timeout(60)
+        .keep_alive(KeepAlive::Timeout(Duration::new(2, 0)))
         .bind(&self.addr)
         .map_err(|e| {
             error!(

httpw/src/viewmodels/error.rs

@@ -1,8 +1,8 @@
-use std::fmt;
-
 use serde::Serialize;
+use std::fmt;
+use utoipa::ToSchema;
 
-#[derive(Debug, Default, Serialize)]
+#[derive(Debug, Default, Serialize, ToSchema)]
 pub struct HttpErrorViewModel {
     pub status_code: u16,
     pub message: String,