Add utoipa for api-docs

Cargo.toml

@@ -32,3 +32,5 @@ jsonwebtoken = "9.3.0"
 http = "1.1.0"
 openssl = "0.10.64"
 alcoholic_jwt = "4091.0.0"
+utoipa = { version = "4.2.3", features = ["actix_extras", "chrono", "yaml", "uuid"] }
+utoipa-swagger-ui = { version = "7.0.1", features = ["actix-web"] }

src/main.rs

@@ -12,6 +12,22 @@ use crate::user_flow::requests::{check_token, login, register};
 use crate::utils::init_logging;
 use actix::Actor;
 use actix_web::web::Data;
+use utoipa_swagger_ui::SwaggerUi;
+
+use utoipa::OpenApi;
+
+#[derive(OpenApi)]
+#[openapi(
+    paths(
+        crate::user_flow::requests::login,
+        crate::user_flow::requests::register
+    ),
+    components(
+        schemas(crate::models::RegisteredUserData),
+        schemas(crate::models::UserData)
+    )
+)]
+struct ApiDoc;
 
 #[actix_web::main]
 async fn main() -> Result<()> {
@@ -22,11 +38,15 @@ async fn main() -> Result<()> {
     let pool = db::utils::create_connection_pool(database_url).await?;
     let db = DbService::new(pool);
     let db = db.start();
+    let openapi = ApiDoc::openapi();
     actix_web::HttpServer::new(move || {
         actix_web::App::new()
             .route("/login", actix_web::web::post().to(login))
             .route("/register", actix_web::web::post().to(register))
             .route("/check_token", actix_web::web::get().to(check_token))
+            .service(
+                SwaggerUi::new("/swagger-ui/{_:.*}").url("/api-docs/openapi.json", openapi.clone()),
+            )
             .app_data(Data::new(db.clone()))
     })
     .bind("localhost:8080")?

src/models.rs

@@ -1,14 +1,15 @@
 use serde::{Deserialize, Serialize};
+use utoipa::ToSchema;
 use uuid::Uuid;
 
-#[derive(Debug, Clone, Serialize, Deserialize)]
+#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
 pub struct UserData {
     pub username: String,
     pub password: String,
     pub email: String,
 }
 
-#[derive(Debug, Clone, Serialize, Deserialize)]
+#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
 pub struct RegisteredUserData {
     pub id: Uuid,
     pub username: String,

src/user_flow/requests.rs

@@ -9,6 +9,14 @@ use actix_web::{HttpRequest, HttpResponse};
 use alcoholic_jwt::{token_kid, validate, Validation};
 use uuid::Uuid;
 
+#[utoipa::path(
+    post,
+    path = "/register",
+    responses(
+        (status = 200, description = "User successfully registered", body = UserData),
+        (status = BAD_REQUEST, description = "User already registered")
+    )
+)]
 pub async fn register(
     user: Json<UserData>,
     db: Data<Addr<DbService>>,
@@ -38,6 +46,14 @@ pub async fn register(
     Ok(HttpResponse::Ok().body(serde_json::to_string(&user)?))
 }
 
+#[utoipa::path(
+    post,
+    path = "/login",
+    responses(
+        (status = 200, description = "User successfully login", body = RegisteredUserData),
+        (status = BAD_REQUEST, description = "User not found")
+    )
+)]
 pub async fn login(
     db: Data<Addr<DbService>>,
     user: Json<RegisteredUserData>,
@@ -54,6 +70,14 @@ pub async fn login(
     }
 }
 
+#[utoipa::path(
+    post,
+    path = "/check_token",
+    responses(
+        (status = 200, description = "This is a right token"),
+        (status = BAD_REQUEST, description = "Not correct token")
+    )
+)]
 pub async fn check_token(req: HttpRequest) -> crate::errors::Result<HttpResponse> {
     log::info!("Getting request for checking token!");
     let token = req