From e950a33e982a3b7ce4efba56f736f44cb575d875 Mon Sep 17 00:00:00 2001
From: Tobias Reisinger <tobias@msrg.cc>
Date: Mon, 22 Apr 2024 03:41:41 +0200
Subject: [PATCH] Add swagger-ui

---
 Cargo.lock                                  | Bin 64009 -> 68399 bytes
 emgauwa-core/Cargo.toml                     |   3 +
 emgauwa-core/build.rs                       |  16 ++++-
 emgauwa-core/src/handlers/v1/controllers.rs |   8 +--
 emgauwa-core/src/handlers/v1/relays.rs      |  10 +--
 emgauwa-core/src/handlers/v1/schedules.rs   |  14 ++---
 emgauwa-core/src/handlers/v1/tags.rs        |   8 +--
 emgauwa-core/src/handlers/v1/ws/mod.rs      |   2 +-
 emgauwa-core/src/main.rs                    |  64 +++++++++++++-------
 9 files changed, 81 insertions(+), 44 deletions(-)

diff --git a/Cargo.lock b/Cargo.lock
index a5355d672e39814674fbde6b30af59e37581591d..8b6ca2aabe0555a9690b8742e879d8d702fc995e 100644
GIT binary patch
delta 2145
zcmaJ?OKg=z6pm1^79|y>1uCJG1sc4~ydOSjg~T<5jjr&_%$ahf_rbj_MPtH>g*(h7
zn&1XCabZk^+$AQ41-fEOVvHmW=)x5wCYor_^WR&sEylaK^G{~xob#RU`_B8nZvN`S
zp({g2Cl*`vHcY)ZGC8%>U)H+IFh7r-+ETsu;K&!xmmRO|?|pOn*645pPtGr4w_DEa
zg2Re?A&iVdI?$OV7EQ=W@GPYP$t9?WJSxq!5=!|9-188Owm}&s%Eepbqm6n42Z5XQ
z2wg05kMHS~_x{}TYz;e|R%dGDEOxr}R&(;z$thmW?>aG)KxpMz&fa+e5M++oMrks0
zF$d2?N)j!Pz_QO?a~lwt04qU9l&-9NJXVhF9oaSrP=m$APPuyVK)G~nq}=5%9B6l1
zvDSdtX{|Z&Xdbh`11iQHLoF~y?;trAxKm!L09huM1SMd-whEQ>kTqy6tO`<RXMDMT
zX{=oQZg=^aAM9QD=-ZK<*a(=`MRL=!Tvc<kIarsKNsJl8v`pM26~PAQ9a1<MqSTUQ
zs@m|RDG?QuVhR#4<E+x<v8Q*k&Qf==){jxEH`)t**w^eWE!G#h{mo@qIGyU9su%m#
z9Oz$K+mF@kW`gGs1;}V3(}ID_L8j!q6r5XXO*CG3X`{j*IBiSo1osIzi%R8K?p+$M
zfH<@!*1ySg-)T;YX*Mn0#@r?!IlnPEe&hIIlZ|K2GbyyOnSKfh7R95s#2h7Q!<cAO
zuu&W5f<Wty*G@^LwJX=#W24<uAT|c?z5eOhp>b$nE!P)tUDNn<;a?t~@$@`TQ38Mu
z8I#w@1ez*(2o*ytN@iVPA@QJ+4ThG+5jdVP&B~d>W80SNO=#C^6&mG}YZJY%KYvO;
zLo!(xPfXhZNo*2HCCI^eLqIbRjyt2Gk37)7vL3mRI<k}$a__xR!CTU%^hoWhNK%fD
z9W2Lw9PZux;l`FNeKRO;jl!(30z=9nde1p$QZmVt$ebZ5z)2#dL6t;wC?F=VhE$Ky
zR<9eM!B%f?uQwB(Ye2i-Pf@NP**W@lx7F-JyJ|e;uh!m?)%83!tJpJ1MxRw;PD)3W
z&}&oxO0T#8rWiP4yUCI}Vja~Cq&+1qaMC3cHvc2|tphoe){pLc#OBrkYRcukCuUfX
z-WivajEr+{I5HI!H$oz{2QXzps+UF+u|&?+6SBy%<CH=csqi<(%H+1Khn6w)E3B+;
zV4nTY4$kAb!RnzdD@evSK+-?*ZoS=i#t&8&Hf<S*bN>zM3b_mOWTs4I&y$ZjF+;vc
zhLZ^*Ao?*AHD>fmD-JdpXC!A1$qZ42sw=y@4@q1NfVGUPy!ekhKW*Ji94t3qhFKjQ
z`IxaJ+GK(Jmz+<N%#}b;j6onXB34;tEWss-b6hc<1d*I&nigfHHTKeg(sjzD){Zrb
zms-o++I(}VU+HT6bIzPJYQupFf<3DT{^NeReF|nE%HV7?(g;S}OUVbKELN?N!eh=_
z=@4TGL8>eRGM}>{#X!(J*ih!~PYgel-0TII&2)<}<=zD#M>m1=lo|O&wTsC}i8Sz%
z4vxs77-_e%4v)$JF~ggx=Ao+QGWX`hbN^f3?Ni|uE>H;T6i-as$dLvp=`09Av_~2s
z%5Xr3%4HBV0X#+}A{mXBoR^h56Xo)~t-ZUyoPTmhy}gdqY}%A#7v^THVI&<CiUb=4
z8HCT|#mYJIZWl5)SrebQ0n9*rk|G4EkI+dPy)cy_mMh<He<F6Gq@=ow<$)a^o}9`H
Su!y2+QJMXHsF#2HY}4Np`kt%+

delta 69
zcmV-L0J{ILmIR6P1F!@`vn4~MD3e@X7qjYX))2F*efk=+;hMY(v%9Eq1hWvX4K=d?
b<jDoIC+%wjvx4yB2DAP8gABKc2mz)7dZr-k

diff --git a/emgauwa-core/Cargo.toml b/emgauwa-core/Cargo.toml
index 6400d42..1bb4ef4 100644
--- a/emgauwa-core/Cargo.toml
+++ b/emgauwa-core/Cargo.toml
@@ -12,6 +12,9 @@ actix-web = "4.4"
 actix-web-actors = "4.2"
 actix-cors = "0.7"
 
+utoipa = "4.2"
+utoipa-swagger-ui = { version = "6.0", features = ["actix-web", "debug-embed"] }
+
 log = "0.4"
 
 chrono = { version = "0.4", features = ["serde"] }
diff --git a/emgauwa-core/build.rs b/emgauwa-core/build.rs
index 41015be..443df4c 100644
--- a/emgauwa-core/build.rs
+++ b/emgauwa-core/build.rs
@@ -1,3 +1,17 @@
+use std::process::{exit, Command};
+
 fn main() {
-	println!("cargo:rustc-env=DATABASE_URL=sqlite://emgauwa-core.sqlite")
+	println!("cargo:rustc-env=DATABASE_URL=sqlite://emgauwa-core.sqlite");
+
+	println!("cargo:rerun-if-changed=../api.v1.yaml");
+	let output = Command::new("sh")
+		.arg("-c")
+		.arg("yq . < ../api.v1.yaml > $OUT_DIR/api.v1.json")
+		.output()
+		.expect("Failed to convert api documentation to json");
+
+	if !output.status.success() {
+		eprintln!("Error: {}", String::from_utf8_lossy(&output.stderr));
+		exit(1);
+	}
 }
diff --git a/emgauwa-core/src/handlers/v1/controllers.rs b/emgauwa-core/src/handlers/v1/controllers.rs
index 1fdd6cd..eb1b870 100644
--- a/emgauwa-core/src/handlers/v1/controllers.rs
+++ b/emgauwa-core/src/handlers/v1/controllers.rs
@@ -9,7 +9,7 @@ use sqlx::{Pool, Sqlite};
 use crate::app_state;
 use crate::app_state::AppState;
 
-#[get("/api/v1/controllers")]
+#[get("/controllers")]
 pub async fn index(pool: web::Data<Pool<Sqlite>>) -> Result<HttpResponse, EmgauwaError> {
 	let mut pool_conn = pool.acquire().await?;
 
@@ -20,7 +20,7 @@ pub async fn index(pool: web::Data<Pool<Sqlite>>) -> Result<HttpResponse, Emgauw
 	Ok(HttpResponse::Ok().json(controllers))
 }
 
-#[get("/api/v1/controllers/{controller_id}")]
+#[get("/controllers/{controller_id}")]
 pub async fn show(
 	pool: web::Data<Pool<Sqlite>>,
 	path: web::Path<(String,)>,
@@ -38,7 +38,7 @@ pub async fn show(
 	Ok(HttpResponse::Ok().json(return_controller))
 }
 
-#[put("/api/v1/controllers/{controller_id}")]
+#[put("/controllers/{controller_id}")]
 pub async fn update(
 	pool: web::Data<Pool<Sqlite>>,
 	app_state: web::Data<Addr<AppState>>,
@@ -70,7 +70,7 @@ pub async fn update(
 	Ok(HttpResponse::Ok().json(return_controller))
 }
 
-#[delete("/api/v1/controllers/{controller_id}")]
+#[delete("/controllers/{controller_id}")]
 pub async fn delete(
 	pool: web::Data<Pool<Sqlite>>,
 	app_state: web::Data<Addr<AppState>>,
diff --git a/emgauwa-core/src/handlers/v1/relays.rs b/emgauwa-core/src/handlers/v1/relays.rs
index 6f2ddfa..2d519d4 100644
--- a/emgauwa-core/src/handlers/v1/relays.rs
+++ b/emgauwa-core/src/handlers/v1/relays.rs
@@ -10,7 +10,7 @@ use sqlx::{Pool, Sqlite};
 use crate::app_state;
 use crate::app_state::AppState;
 
-#[get("/api/v1/relays")]
+#[get("/relays")]
 pub async fn index(pool: web::Data<Pool<Sqlite>>) -> Result<HttpResponse, EmgauwaError> {
 	let mut pool_conn = pool.acquire().await?;
 
@@ -21,7 +21,7 @@ pub async fn index(pool: web::Data<Pool<Sqlite>>) -> Result<HttpResponse, Emgauw
 	Ok(HttpResponse::Ok().json(relays))
 }
 
-#[get("/api/v1/relays/tag/{tag}")]
+#[get("/relays/tag/{tag}")]
 pub async fn tagged(
 	pool: web::Data<Pool<Sqlite>>,
 	path: web::Path<(String,)>,
@@ -39,7 +39,7 @@ pub async fn tagged(
 	Ok(HttpResponse::Ok().json(relays))
 }
 
-#[get("/api/v1/controllers/{controller_id}/relays")]
+#[get("/controllers/{controller_id}/relays")]
 pub async fn index_for_controller(
 	pool: web::Data<Pool<Sqlite>>,
 	path: web::Path<(String,)>,
@@ -59,7 +59,7 @@ pub async fn index_for_controller(
 	Ok(HttpResponse::Ok().json(relays))
 }
 
-#[get("/api/v1/controllers/{controller_id}/relays/{relay_num}")]
+#[get("/controllers/{controller_id}/relays/{relay_num}")]
 pub async fn show_for_controller(
 	pool: web::Data<Pool<Sqlite>>,
 	path: web::Path<(String, i64)>,
@@ -81,7 +81,7 @@ pub async fn show_for_controller(
 	Ok(HttpResponse::Ok().json(return_relay))
 }
 
-#[put("/api/v1/controllers/{controller_id}/relays/{relay_num}")]
+#[put("/controllers/{controller_id}/relays/{relay_num}")]
 pub async fn update_for_controller(
 	pool: web::Data<Pool<Sqlite>>,
 	app_state: web::Data<Addr<AppState>>,
diff --git a/emgauwa-core/src/handlers/v1/schedules.rs b/emgauwa-core/src/handlers/v1/schedules.rs
index a1d1583..1130e6b 100644
--- a/emgauwa-core/src/handlers/v1/schedules.rs
+++ b/emgauwa-core/src/handlers/v1/schedules.rs
@@ -6,7 +6,7 @@ use emgauwa_lib::types::{RequestCreateSchedule, RequestUpdateSchedule, ScheduleU
 use sqlx::pool::PoolConnection;
 use sqlx::{Pool, Sqlite};
 
-#[get("/api/v1/schedules")]
+#[get("/schedules")]
 pub async fn index(pool: web::Data<Pool<Sqlite>>) -> Result<HttpResponse, EmgauwaError> {
 	let mut pool_conn = pool.acquire().await?;
 
@@ -16,7 +16,7 @@ pub async fn index(pool: web::Data<Pool<Sqlite>>) -> Result<HttpResponse, Emgauw
 	Ok(HttpResponse::Ok().json(schedules))
 }
 
-#[get("/api/v1/schedules/tag/{tag}")]
+#[get("/schedules/tag/{tag}")]
 pub async fn tagged(
 	pool: web::Data<Pool<Sqlite>>,
 	path: web::Path<(String,)>,
@@ -34,7 +34,7 @@ pub async fn tagged(
 	Ok(HttpResponse::Ok().json(schedules))
 }
 
-#[get("/api/v1/schedules/{schedule_id}")]
+#[get("/schedules/{schedule_id}")]
 pub async fn show(
 	pool: web::Data<Pool<Sqlite>>,
 	path: web::Path<(String,)>,
@@ -52,7 +52,7 @@ pub async fn show(
 	Ok(HttpResponse::Ok().json(return_schedule))
 }
 
-#[post("/api/v1/schedules")]
+#[post("/schedules")]
 pub async fn add(
 	pool: web::Data<Pool<Sqlite>>,
 	data: web::Json<RequestCreateSchedule>,
@@ -96,7 +96,7 @@ async fn add_list_single(
 	Ok(new_schedule)
 }
 
-#[post("/api/v1/schedules/list")]
+#[post("/schedules/list")]
 pub async fn add_list(
 	pool: web::Data<Pool<Sqlite>>,
 	data: web::Json<Vec<RequestCreateSchedule>>,
@@ -113,7 +113,7 @@ pub async fn add_list(
 	Ok(HttpResponse::Created().json(schedules))
 }
 
-#[put("/api/v1/schedules/{schedule_id}")]
+#[put("/schedules/{schedule_id}")]
 pub async fn update(
 	pool: web::Data<Pool<Sqlite>>,
 	path: web::Path<(String,)>,
@@ -148,7 +148,7 @@ pub async fn update(
 	Ok(HttpResponse::Ok().json(return_schedule))
 }
 
-#[delete("/api/v1/schedules/{schedule_id}")]
+#[delete("/schedules/{schedule_id}")]
 pub async fn delete(
 	pool: web::Data<Pool<Sqlite>>,
 	path: web::Path<(String,)>,
diff --git a/emgauwa-core/src/handlers/v1/tags.rs b/emgauwa-core/src/handlers/v1/tags.rs
index 851bf98..5a42715 100644
--- a/emgauwa-core/src/handlers/v1/tags.rs
+++ b/emgauwa-core/src/handlers/v1/tags.rs
@@ -5,7 +5,7 @@ use emgauwa_lib::models::{FromDbModel, Tag};
 use emgauwa_lib::types::RequestCreateTag;
 use sqlx::{Pool, Sqlite};
 
-#[get("/api/v1/tags")]
+#[get("/tags")]
 pub async fn index(pool: web::Data<Pool<Sqlite>>) -> Result<HttpResponse, EmgauwaError> {
 	let mut pool_conn = pool.acquire().await?;
 
@@ -16,7 +16,7 @@ pub async fn index(pool: web::Data<Pool<Sqlite>>) -> Result<HttpResponse, Emgauw
 	Ok(HttpResponse::Ok().json(tags))
 }
 
-#[get("/api/v1/tags/{tag_name}")]
+#[get("/tags/{tag_name}")]
 pub async fn show(
 	pool: web::Data<Pool<Sqlite>>,
 	path: web::Path<(String,)>,
@@ -33,7 +33,7 @@ pub async fn show(
 	Ok(HttpResponse::Ok().json(return_tag))
 }
 
-#[delete("/api/v1/tags/{tag_name}")]
+#[delete("/tags/{tag_name}")]
 pub async fn delete(
 	pool: web::Data<Pool<Sqlite>>,
 	path: web::Path<(String,)>,
@@ -46,7 +46,7 @@ pub async fn delete(
 	Ok(HttpResponse::Ok().json("tag got deleted"))
 }
 
-#[post("/api/v1/tags")]
+#[post("/tags")]
 pub async fn add(
 	pool: web::Data<Pool<Sqlite>>,
 	data: web::Json<RequestCreateTag>,
diff --git a/emgauwa-core/src/handlers/v1/ws/mod.rs b/emgauwa-core/src/handlers/v1/ws/mod.rs
index 23a545a..cda5a47 100644
--- a/emgauwa-core/src/handlers/v1/ws/mod.rs
+++ b/emgauwa-core/src/handlers/v1/ws/mod.rs
@@ -11,7 +11,7 @@ use crate::handlers::v1::ws::controllers::ControllerWs;
 
 pub mod controllers;
 
-#[get("/api/v1/ws/controllers")]
+#[get("/ws/controllers")]
 pub async fn ws_controllers(
 	pool: web::Data<Pool<Sqlite>>,
 	app_state: web::Data<Addr<AppState>>,
diff --git a/emgauwa-core/src/main.rs b/emgauwa-core/src/main.rs
index 1191da6..6bd47a3 100644
--- a/emgauwa-core/src/main.rs
+++ b/emgauwa-core/src/main.rs
@@ -7,6 +7,8 @@ use actix_web::{middleware, web, App, HttpServer};
 use emgauwa_lib::db::DbController;
 use emgauwa_lib::errors::EmgauwaError;
 use emgauwa_lib::utils::{drop_privileges, init_logging};
+use serde_json::json;
+use utoipa_swagger_ui::SwaggerUi;
 
 use crate::app_state::AppState;
 
@@ -61,34 +63,52 @@ async fn main() -> Result<(), std::io::Error> {
 			}),
 		};
 
+		let api_default = json!({
+			"openapi": "3.0.0",
+			"info": {
+				"version": "0.0.0",
+				"title": "Failed to load API documentation",
+			}
+		});
+		let api_v1_json =
+			serde_json::from_str(include_str!(concat!(env!("OUT_DIR"), "/api.v1.json")))
+				.unwrap_or(api_default.clone());
+
 		App::new()
 			.wrap(cors)
 			.wrap(middleware::Logger::default())
-			.wrap(middleware::NormalizePath::new(TrailingSlash::Trim))
 			.app_data(web::JsonConfig::default().error_handler(handlers::json_error_handler))
 			.app_data(web::Data::new(pool.clone()))
 			.app_data(web::Data::new(app_state.clone()))
-			.service(handlers::v1::controllers::index)
-			.service(handlers::v1::controllers::show)
-			.service(handlers::v1::controllers::update)
-			.service(handlers::v1::controllers::delete)
-			.service(handlers::v1::relays::index)
-			.service(handlers::v1::relays::tagged)
-			.service(handlers::v1::relays::index_for_controller)
-			.service(handlers::v1::relays::show_for_controller)
-			.service(handlers::v1::relays::update_for_controller)
-			.service(handlers::v1::schedules::index)
-			.service(handlers::v1::schedules::tagged)
-			.service(handlers::v1::schedules::show)
-			.service(handlers::v1::schedules::add)
-			.service(handlers::v1::schedules::add_list)
-			.service(handlers::v1::schedules::update)
-			.service(handlers::v1::schedules::delete)
-			.service(handlers::v1::tags::index)
-			.service(handlers::v1::tags::show)
-			.service(handlers::v1::tags::delete)
-			.service(handlers::v1::tags::add)
-			.service(handlers::v1::ws::ws_controllers)
+			.service(
+				SwaggerUi::new("/api/docs/{_:.*}")
+					.external_urls_from_iter_unchecked([("/api/v1.json", api_v1_json)]),
+			)
+			.service(
+				web::scope("/api/v1")
+					.wrap(middleware::NormalizePath::new(TrailingSlash::Trim))
+					.service(handlers::v1::controllers::index)
+					.service(handlers::v1::controllers::show)
+					.service(handlers::v1::controllers::update)
+					.service(handlers::v1::controllers::delete)
+					.service(handlers::v1::relays::index)
+					.service(handlers::v1::relays::tagged)
+					.service(handlers::v1::relays::index_for_controller)
+					.service(handlers::v1::relays::show_for_controller)
+					.service(handlers::v1::relays::update_for_controller)
+					.service(handlers::v1::schedules::index)
+					.service(handlers::v1::schedules::tagged)
+					.service(handlers::v1::schedules::show)
+					.service(handlers::v1::schedules::add)
+					.service(handlers::v1::schedules::add_list)
+					.service(handlers::v1::schedules::update)
+					.service(handlers::v1::schedules::delete)
+					.service(handlers::v1::tags::index)
+					.service(handlers::v1::tags::show)
+					.service(handlers::v1::tags::delete)
+					.service(handlers::v1::tags::add)
+					.service(handlers::v1::ws::ws_controllers),
+			)
 	})
 	.listen(listener)?
 	.run()