2025-09-23 20:54:50 +02:00
|
|
|
//! # Module Server - API de haut niveau pour Axum
|
|
|
|
|
//!
|
|
|
|
|
//! Ce module fournit une abstraction simple et ergonomique pour créer des serveurs HTTP
|
|
|
|
|
//! avec Axum, en cachant la complexité de la configuration et du routage.
|
|
|
|
|
//!
|
|
|
|
|
//! ## Fonctionnalités
|
|
|
|
|
//!
|
|
|
|
|
//! - 🚀 **Routes JSON simples** : Ajoutez des endpoints API avec `add_route()`
|
|
|
|
|
//! - 📁 **Fichiers statiques** : Servez des assets avec `add_dir()`
|
|
|
|
|
//! - ⚛️ **Applications SPA** : Support pour Vue.js/React avec `add_spa()`
|
|
|
|
|
//! - 🔀 **Redirections** : Redirigez des routes avec `add_redirect()`
|
|
|
|
|
//! - 🎯 **Handlers personnalisés** : Support SSE, WebSocket, etc. avec `add_handler_with_state()`
|
2025-10-01 07:42:16 +02:00
|
|
|
//! - 📚 **Documentation API** : OpenAPI/Swagger automatique avec `add_openapi()`
|
2025-09-23 20:54:50 +02:00
|
|
|
//! - ⚡ **Gestion gracieuse** : Arrêt propre sur Ctrl+C
|
|
|
|
|
|
2025-10-07 08:33:06 +02:00
|
|
|
use crate::logs::{LogState, LoggingOptions, init_logging, log_dump, log_sse};
|
2025-09-23 20:54:50 +02:00
|
|
|
use axum::handler::Handler;
|
|
|
|
|
use axum::response::Redirect;
|
|
|
|
|
use axum::routing::get;
|
|
|
|
|
use axum::{Json, Router};
|
|
|
|
|
use axum_embed::ServeEmbed;
|
|
|
|
|
use pmoconfig::get_config;
|
|
|
|
|
use rust_embed::RustEmbed;
|
|
|
|
|
use serde::Serialize;
|
|
|
|
|
use std::{net::SocketAddr, sync::Arc};
|
|
|
|
|
use tokio::{signal, sync::RwLock, task::JoinHandle};
|
2025-10-06 07:31:03 +02:00
|
|
|
use tracing::info;
|
2025-10-01 07:42:16 +02:00
|
|
|
use utoipa_swagger_ui::SwaggerUi;
|
2025-09-23 20:54:50 +02:00
|
|
|
|
|
|
|
|
/// Info serveur sérialisable
|
2025-10-01 07:42:16 +02:00
|
|
|
#[derive(Clone, Serialize, utoipa::ToSchema)]
|
2025-09-23 20:54:50 +02:00
|
|
|
pub struct ServerInfo {
|
2025-10-01 07:42:16 +02:00
|
|
|
/// Nom du serveur
|
2025-09-23 20:54:50 +02:00
|
|
|
pub name: String,
|
2025-10-01 07:42:16 +02:00
|
|
|
/// URL de base
|
2025-09-23 20:54:50 +02:00
|
|
|
pub base_url: String,
|
2025-10-01 07:42:16 +02:00
|
|
|
/// Port HTTP
|
2025-09-23 20:54:50 +02:00
|
|
|
pub http_port: u16,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Serveur principal
|
|
|
|
|
pub struct Server {
|
|
|
|
|
name: String,
|
|
|
|
|
base_url: String,
|
|
|
|
|
http_port: u16,
|
|
|
|
|
router: Arc<RwLock<Router>>,
|
2025-10-01 07:42:16 +02:00
|
|
|
api_router: Arc<RwLock<Option<Router>>>,
|
2025-09-23 20:54:50 +02:00
|
|
|
join_handle: Option<JoinHandle<()>>,
|
2025-10-06 20:24:04 +02:00
|
|
|
log_state: Option<LogState>,
|
2025-09-23 20:54:50 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl Server {
|
|
|
|
|
/// Crée une nouvelle instance de serveur
|
|
|
|
|
///
|
|
|
|
|
/// # Arguments
|
|
|
|
|
///
|
|
|
|
|
/// * `name` - Nom du serveur (pour les logs)
|
|
|
|
|
/// * `base_url` - URL de base (ex: "http://localhost:3000")
|
|
|
|
|
/// * `http_port` - Port HTTP à écouter
|
|
|
|
|
///
|
|
|
|
|
/// # Exemple
|
|
|
|
|
///
|
|
|
|
|
/// ```rust
|
|
|
|
|
/// # use pmoupnp::server::Server;
|
|
|
|
|
/// let server = Server::new("MyAPI", "http://localhost:3000", 3000);
|
|
|
|
|
/// ```
|
|
|
|
|
pub fn new(name: impl Into<String>, base_url: impl Into<String>, http_port: u16) -> Self {
|
|
|
|
|
Self {
|
|
|
|
|
name: name.into(),
|
|
|
|
|
base_url: base_url.into(),
|
|
|
|
|
http_port,
|
|
|
|
|
router: Arc::new(RwLock::new(Router::new())),
|
2025-10-01 07:42:16 +02:00
|
|
|
api_router: Arc::new(RwLock::new(None)),
|
2025-09-23 20:54:50 +02:00
|
|
|
join_handle: None,
|
2025-10-06 20:24:04 +02:00
|
|
|
log_state: None,
|
2025-09-23 20:54:50 +02:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
pub fn new_configured() -> Self {
|
|
|
|
|
let config = get_config();
|
|
|
|
|
let url = config.get_base_url();
|
|
|
|
|
let port = config.get_http_port();
|
|
|
|
|
|
|
|
|
|
return Self::new("PMO-Music-Server", url, port);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Ajoute une route JSON dynamique
|
|
|
|
|
///
|
|
|
|
|
/// Crée un endpoint qui retourne du JSON. La closure fournie sera appelée
|
|
|
|
|
/// à chaque requête GET sur le chemin spécifié.
|
|
|
|
|
///
|
|
|
|
|
/// # Arguments
|
|
|
|
|
///
|
|
|
|
|
/// * `path` - Chemin de la route (ex: "/api/hello")
|
|
|
|
|
/// * `f` - Closure async retournant une valeur sérialisable
|
|
|
|
|
///
|
|
|
|
|
/// # Exemple
|
|
|
|
|
///
|
|
|
|
|
/// ```rust,no_run
|
|
|
|
|
/// # use pmoupnp::server::Server;
|
|
|
|
|
/// # #[tokio::main]
|
|
|
|
|
/// # async fn main() {
|
|
|
|
|
/// # let mut server = Server::new("Test", "http://localhost:3000", 3000);
|
|
|
|
|
/// server.add_route("/api/status", || async {
|
|
|
|
|
/// serde_json::json!({
|
|
|
|
|
/// "status": "online",
|
|
|
|
|
/// "version": "1.0.0"
|
|
|
|
|
/// })
|
|
|
|
|
/// }).await;
|
|
|
|
|
/// # }
|
|
|
|
|
/// ```
|
|
|
|
|
pub async fn add_route<F, Fut, T>(&mut self, path: &str, f: F)
|
|
|
|
|
where
|
|
|
|
|
F: Fn() -> Fut + Send + Sync + 'static,
|
|
|
|
|
Fut: std::future::Future<Output = T> + Send + 'static,
|
|
|
|
|
T: Serialize + Send + 'static,
|
|
|
|
|
{
|
|
|
|
|
let f = Arc::new(f);
|
|
|
|
|
|
|
|
|
|
let handler = {
|
|
|
|
|
let f = f.clone();
|
|
|
|
|
move || {
|
|
|
|
|
let f = f.clone();
|
|
|
|
|
async move { Json(f().await) }
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
let route = Router::new().route("/", get(handler));
|
|
|
|
|
|
|
|
|
|
let mut r = self.router.write().await;
|
|
|
|
|
*r = std::mem::take(&mut *r).nest(path, route);
|
|
|
|
|
}
|
|
|
|
|
|
2025-10-07 13:12:44 +02:00
|
|
|
/// Add a new router safely:
|
|
|
|
|
/// - If `path` starts with '/', it is merged at root level.
|
|
|
|
|
/// - Otherwise, it is nested under the given subpath.
|
|
|
|
|
pub async fn add_router(&mut self, path: &str, route: Router) {
|
|
|
|
|
let mut r = self.router.write().await;
|
|
|
|
|
|
|
|
|
|
// Take current router without losing content
|
|
|
|
|
let current = std::mem::take(&mut *r);
|
|
|
|
|
|
|
|
|
|
let combined = if path.starts_with('/') {
|
|
|
|
|
// Absolute path => merge directly at root
|
|
|
|
|
tracing::debug!("Merging router at root path: {}", path);
|
|
|
|
|
current.merge(route)
|
|
|
|
|
} else {
|
|
|
|
|
// Relative path => nest under the given path
|
|
|
|
|
let normalized = format!("/{}", path.trim_start_matches('/'));
|
|
|
|
|
tracing::debug!("Nesting router under: {}", normalized);
|
|
|
|
|
current.nest(&normalized, route)
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
*r = combined;
|
|
|
|
|
}
|
|
|
|
|
|
2025-09-23 20:54:50 +02:00
|
|
|
/// Ajoute un répertoire de fichiers statiques
|
|
|
|
|
///
|
|
|
|
|
/// Sert des fichiers embarqués via `RustEmbed`. Les fichiers sont compilés
|
|
|
|
|
/// dans le binaire à la compilation.
|
|
|
|
|
///
|
|
|
|
|
/// # Arguments
|
|
|
|
|
///
|
|
|
|
|
/// * `path` - Chemin où monter les fichiers statiques
|
|
|
|
|
///
|
|
|
|
|
/// # Type Parameter
|
|
|
|
|
///
|
|
|
|
|
/// * `E` - Type RustEmbed définissant le répertoire à servir
|
|
|
|
|
///
|
|
|
|
|
/// # Exemple
|
|
|
|
|
///
|
2025-10-01 20:49:50 +02:00
|
|
|
/// ```ignore
|
|
|
|
|
/// use pmoupnp::server::Server;
|
|
|
|
|
/// use rust_embed::RustEmbed;
|
2025-10-07 08:33:06 +02:00
|
|
|
///
|
2025-09-23 20:54:50 +02:00
|
|
|
/// #[derive(RustEmbed, Clone)]
|
|
|
|
|
/// #[folder = "static/"]
|
|
|
|
|
/// struct Assets;
|
|
|
|
|
///
|
|
|
|
|
/// # #[tokio::main]
|
|
|
|
|
/// # async fn main() {
|
2025-10-01 20:49:50 +02:00
|
|
|
/// let mut server = Server::new("Test", "http://localhost:3000", 3000);
|
2025-09-23 20:54:50 +02:00
|
|
|
/// server.add_dir::<Assets>("/assets").await;
|
|
|
|
|
/// // Les fichiers de static/ sont accessibles via /assets/*
|
|
|
|
|
/// # }
|
|
|
|
|
/// ```
|
|
|
|
|
pub async fn add_dir<E>(&mut self, path: &str)
|
|
|
|
|
where
|
|
|
|
|
E: RustEmbed + Clone + Send + Sync + 'static,
|
|
|
|
|
{
|
|
|
|
|
let serve = ServeEmbed::<E>::new();
|
2025-10-07 08:33:06 +02:00
|
|
|
|
2025-09-23 20:54:50 +02:00
|
|
|
let mut r = self.router.write().await;
|
2025-10-07 08:33:06 +02:00
|
|
|
|
2025-09-23 20:54:50 +02:00
|
|
|
if path == "/" {
|
|
|
|
|
*r = std::mem::take(&mut *r).fallback_service(serve);
|
|
|
|
|
} else {
|
|
|
|
|
let route = Router::new().fallback_service(serve);
|
|
|
|
|
*r = std::mem::take(&mut *r).nest(path, route);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Ajoute une Single Page Application (SPA)
|
|
|
|
|
///
|
|
|
|
|
/// Sert une application JavaScript moderne (Vue.js, React, etc.) avec support
|
|
|
|
|
/// du routage côté client. Tous les chemins non trouvés renvoient `index.html`
|
|
|
|
|
/// pour permettre au routeur JavaScript de gérer la navigation.
|
|
|
|
|
///
|
|
|
|
|
/// # Arguments
|
|
|
|
|
///
|
|
|
|
|
/// * `path` - Chemin où monter l'application (souvent "/" ou "/app")
|
|
|
|
|
///
|
|
|
|
|
/// # Type Parameter
|
|
|
|
|
///
|
|
|
|
|
/// * `E` - Type RustEmbed contenant les fichiers de la SPA
|
|
|
|
|
///
|
|
|
|
|
/// # Exemple avec Vue.js
|
|
|
|
|
///
|
|
|
|
|
/// ```rust,no_run
|
|
|
|
|
/// # use pmoupnp::server::Server;
|
|
|
|
|
/// # use rust_embed::RustEmbed;
|
|
|
|
|
/// #[derive(RustEmbed, Clone)]
|
|
|
|
|
/// #[folder = "webapp/dist"] // Build output de Vue.js
|
|
|
|
|
/// struct WebApp;
|
|
|
|
|
///
|
|
|
|
|
/// # #[tokio::main]
|
|
|
|
|
/// # async fn main() {
|
|
|
|
|
/// # let mut server = Server::new("Test", "http://localhost:3000", 3000);
|
|
|
|
|
/// server.add_spa::<WebApp>("/").await;
|
|
|
|
|
/// // L'app Vue.js gère toutes les routes comme /about, /users, etc.
|
|
|
|
|
/// # }
|
|
|
|
|
/// ```
|
|
|
|
|
///
|
|
|
|
|
/// # Note
|
|
|
|
|
///
|
|
|
|
|
/// Pour Vue.js/Vite, configure le `base` dans `vite.config.js` si tu montes
|
|
|
|
|
/// sur un sous-chemin :
|
|
|
|
|
/// ```javascript
|
|
|
|
|
/// export default {
|
|
|
|
|
/// base: '/app/'
|
|
|
|
|
/// }
|
|
|
|
|
/// ```
|
|
|
|
|
pub async fn add_spa<E>(&mut self, path: &str)
|
|
|
|
|
where
|
|
|
|
|
E: RustEmbed + Clone + Send + Sync + 'static,
|
|
|
|
|
{
|
|
|
|
|
let serve = ServeEmbed::<E>::with_parameters(
|
|
|
|
|
Some("index.html".to_string()),
|
|
|
|
|
axum_embed::FallbackBehavior::Ok,
|
|
|
|
|
Some("index.html".to_string()),
|
|
|
|
|
);
|
2025-10-07 08:33:06 +02:00
|
|
|
|
2025-09-23 20:54:50 +02:00
|
|
|
let mut r = self.router.write().await;
|
2025-10-07 08:33:06 +02:00
|
|
|
|
2025-09-23 20:54:50 +02:00
|
|
|
if path == "/" {
|
|
|
|
|
*r = std::mem::take(&mut *r).fallback_service(serve);
|
|
|
|
|
} else {
|
|
|
|
|
let route = Router::new().fallback_service(serve);
|
|
|
|
|
*r = std::mem::take(&mut *r).nest(path, route);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Ajoute un handler Axum personnalisé
|
|
|
|
|
///
|
|
|
|
|
/// Pour des cas d'usage avancés nécessitant un contrôle complet sur le handler.
|
|
|
|
|
///
|
|
|
|
|
/// # Arguments
|
|
|
|
|
///
|
|
|
|
|
/// * `path` - Chemin de la route
|
|
|
|
|
/// * `handler` - Handler Axum
|
|
|
|
|
///
|
|
|
|
|
/// # Exemple
|
|
|
|
|
///
|
|
|
|
|
/// ```rust,no_run
|
|
|
|
|
/// # use pmoupnp::server::Server;
|
|
|
|
|
/// # use axum::response::Html;
|
|
|
|
|
/// # #[tokio::main]
|
|
|
|
|
/// # async fn main() {
|
|
|
|
|
/// # let mut server = Server::new("Test", "http://localhost:3000", 3000);
|
|
|
|
|
/// async fn custom_handler() -> Html<&'static str> {
|
|
|
|
|
/// Html("<h1>Custom Response</h1>")
|
|
|
|
|
/// }
|
|
|
|
|
///
|
|
|
|
|
/// server.add_handler("/custom", custom_handler).await;
|
|
|
|
|
/// # }
|
|
|
|
|
/// ```
|
|
|
|
|
pub async fn add_handler<H, T>(&mut self, path: &str, handler: H)
|
|
|
|
|
where
|
|
|
|
|
H: Handler<T, ()>,
|
|
|
|
|
T: 'static,
|
|
|
|
|
{
|
|
|
|
|
let route = Router::new().route("/", get(handler));
|
|
|
|
|
|
|
|
|
|
let mut r = self.router.write().await;
|
|
|
|
|
*r = std::mem::take(&mut *r).nest(path, route);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Ajoute un handler avec state (pour SSE, extracteurs, etc.)
|
|
|
|
|
///
|
|
|
|
|
/// Permet d'utiliser des extracteurs Axum comme `State`, `Query`, etc.
|
|
|
|
|
/// Idéal pour Server-Sent Events (SSE), WebSockets ou tout handler nécessitant un état partagé.
|
|
|
|
|
///
|
|
|
|
|
/// # Arguments
|
|
|
|
|
///
|
|
|
|
|
/// * `path` - Chemin de la route
|
|
|
|
|
/// * `handler` - Handler Axum avec extracteurs
|
|
|
|
|
/// * `state` - État partagé (doit être Clone + Send + Sync)
|
|
|
|
|
///
|
|
|
|
|
/// # Exemple avec SSE
|
|
|
|
|
///
|
2025-10-01 20:49:50 +02:00
|
|
|
/// ```ignore
|
|
|
|
|
/// use pmoupnp::server::Server;
|
|
|
|
|
/// use axum::extract::State;
|
|
|
|
|
/// use axum::response::sse::{Event, Sse, KeepAlive};
|
|
|
|
|
/// use tokio::sync::broadcast;
|
2025-10-07 08:33:06 +02:00
|
|
|
///
|
2025-10-01 20:49:50 +02:00
|
|
|
/// #[derive(Clone)]
|
2025-10-07 08:33:06 +02:00
|
|
|
/// struct LogState {
|
|
|
|
|
/// tx: broadcast::Sender<String>
|
2025-10-01 20:49:50 +02:00
|
|
|
/// }
|
2025-10-07 08:33:06 +02:00
|
|
|
///
|
|
|
|
|
/// impl LogState {
|
|
|
|
|
/// fn subscribe(&self) -> broadcast::Receiver<String> {
|
|
|
|
|
/// self.tx.subscribe()
|
|
|
|
|
/// }
|
2025-10-01 20:49:50 +02:00
|
|
|
/// }
|
2025-10-07 08:33:06 +02:00
|
|
|
///
|
2025-09-23 20:54:50 +02:00
|
|
|
/// async fn log_sse(State(state): State<LogState>) -> Sse<impl futures::Stream<Item = Result<Event, std::convert::Infallible>>> {
|
|
|
|
|
/// let mut rx = state.subscribe();
|
|
|
|
|
/// let stream = async_stream::stream! {
|
|
|
|
|
/// while let Ok(msg) = rx.recv().await {
|
|
|
|
|
/// yield Ok(Event::default().data(msg));
|
|
|
|
|
/// }
|
|
|
|
|
/// };
|
|
|
|
|
/// Sse::new(stream).keep_alive(KeepAlive::default())
|
|
|
|
|
/// }
|
|
|
|
|
///
|
|
|
|
|
/// let log_state = LogState { tx: broadcast::channel(100).0 };
|
|
|
|
|
/// server.add_handler_with_state("/logs", log_sse, log_state).await;
|
|
|
|
|
/// ```
|
|
|
|
|
pub async fn add_handler_with_state<H, T, S>(&mut self, path: &str, handler: H, state: S)
|
|
|
|
|
where
|
|
|
|
|
H: Handler<T, S>,
|
|
|
|
|
T: 'static,
|
|
|
|
|
S: Clone + Send + Sync + 'static,
|
|
|
|
|
{
|
2025-10-07 08:33:06 +02:00
|
|
|
let route = Router::new().route("/", get(handler)).with_state(state);
|
2025-09-23 20:54:50 +02:00
|
|
|
|
|
|
|
|
let mut r = self.router.write().await;
|
|
|
|
|
*r = std::mem::take(&mut *r).nest(path, route);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Ajoute un handler POST avec state
|
|
|
|
|
///
|
|
|
|
|
/// Similaire à `add_handler_with_state` mais pour les requêtes POST.
|
|
|
|
|
///
|
|
|
|
|
/// # Arguments
|
|
|
|
|
///
|
|
|
|
|
/// * `path` - Chemin de la route
|
|
|
|
|
/// * `handler` - Handler Axum pour POST
|
|
|
|
|
/// * `state` - État partagé
|
|
|
|
|
pub async fn add_post_handler_with_state<H, T, S>(&mut self, path: &str, handler: H, state: S)
|
|
|
|
|
where
|
|
|
|
|
H: Handler<T, S>,
|
|
|
|
|
T: 'static,
|
|
|
|
|
S: Clone + Send + Sync + 'static,
|
|
|
|
|
{
|
|
|
|
|
let route = Router::new()
|
|
|
|
|
.route("/", axum::routing::post(handler))
|
|
|
|
|
.with_state(state);
|
|
|
|
|
|
|
|
|
|
let mut r = self.router.write().await;
|
|
|
|
|
*r = std::mem::take(&mut *r).nest(path, route);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Ajoute une redirection HTTP
|
|
|
|
|
///
|
|
|
|
|
/// Redirige automatiquement les requêtes d'un chemin vers un autre avec un code 308 (permanent).
|
|
|
|
|
///
|
|
|
|
|
/// # Arguments
|
|
|
|
|
///
|
|
|
|
|
/// * `from` - Chemin source (peut être "/" pour la racine)
|
|
|
|
|
/// * `to` - Chemin de destination
|
|
|
|
|
///
|
|
|
|
|
/// # Exemple
|
|
|
|
|
///
|
|
|
|
|
/// ```rust,no_run
|
|
|
|
|
/// # use pmoupnp::server::Server;
|
|
|
|
|
/// # #[tokio::main]
|
|
|
|
|
/// # async fn main() {
|
|
|
|
|
/// # let mut server = Server::new("Test", "http://localhost:3000", 3000);
|
|
|
|
|
/// // Rediriger la racine vers /app
|
|
|
|
|
/// server.add_redirect("/", "/app").await;
|
|
|
|
|
/// # }
|
|
|
|
|
/// ```
|
|
|
|
|
pub async fn add_redirect(&mut self, from: &str, to: &str) {
|
|
|
|
|
let to = to.to_string();
|
|
|
|
|
let handler = move || {
|
|
|
|
|
let to = to.clone();
|
|
|
|
|
async move { Redirect::permanent(&to) }
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
let mut r = self.router.write().await;
|
|
|
|
|
|
|
|
|
|
if from == "/" {
|
|
|
|
|
// Pour la racine, utiliser merge au lieu de nest
|
|
|
|
|
let route = Router::new().route("/", get(handler));
|
|
|
|
|
*r = std::mem::take(&mut *r).merge(route);
|
|
|
|
|
} else {
|
|
|
|
|
let route = Router::new().route("/", get(handler));
|
|
|
|
|
*r = std::mem::take(&mut *r).nest(from, route);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2025-10-07 08:33:06 +02:00
|
|
|
/// Ajoute une API documentée avec OpenAPI et Swagger UI
|
2025-10-01 07:42:16 +02:00
|
|
|
///
|
2025-10-07 08:33:06 +02:00
|
|
|
/// Cette méthode fusionne le `api_router` fourni avec le router principal du serveur.
|
|
|
|
|
/// Chaque appel peut ajouter une nouvelle API distincte, avec sa propre documentation Swagger.
|
2025-10-01 07:42:16 +02:00
|
|
|
///
|
|
|
|
|
/// # Arguments
|
|
|
|
|
///
|
|
|
|
|
/// * `api_router` - Router Axum contenant les routes API
|
2025-10-07 08:33:06 +02:00
|
|
|
/// * `openapi` - Spécification OpenAPI générée par `utoipa`
|
|
|
|
|
/// * `name` - Nom unique pour cette API, utilisé pour différencier le chemin Swagger UI et le JSON OpenAPI
|
2025-10-01 07:42:16 +02:00
|
|
|
///
|
|
|
|
|
/// # Exemple
|
|
|
|
|
///
|
2025-10-01 20:49:50 +02:00
|
|
|
/// ```ignore
|
2025-10-01 07:42:16 +02:00
|
|
|
/// use utoipa::OpenApi;
|
|
|
|
|
/// use axum::{Router, Json, routing::get};
|
2025-10-01 20:49:50 +02:00
|
|
|
/// use serde::{Serialize, Deserialize};
|
|
|
|
|
///
|
|
|
|
|
/// #[derive(Serialize, Deserialize, utoipa::ToSchema)]
|
|
|
|
|
/// struct User {
|
|
|
|
|
/// id: u64,
|
|
|
|
|
/// name: String,
|
|
|
|
|
/// }
|
2025-10-01 07:42:16 +02:00
|
|
|
///
|
|
|
|
|
/// #[derive(utoipa::OpenApi)]
|
|
|
|
|
/// #[openapi(
|
|
|
|
|
/// paths(get_users),
|
|
|
|
|
/// components(schemas(User))
|
|
|
|
|
/// )]
|
2025-10-07 08:33:06 +02:00
|
|
|
/// struct ApiDoc1;
|
2025-10-01 07:42:16 +02:00
|
|
|
///
|
|
|
|
|
/// #[utoipa::path(
|
|
|
|
|
/// get,
|
|
|
|
|
/// path = "/users",
|
|
|
|
|
/// responses((status = 200, description = "List users"))
|
|
|
|
|
/// )]
|
|
|
|
|
/// async fn get_users() -> Json<Vec<User>> {
|
|
|
|
|
/// Json(vec![])
|
|
|
|
|
/// }
|
|
|
|
|
///
|
2025-10-07 08:33:06 +02:00
|
|
|
/// #[derive(utoipa::OpenApi)]
|
|
|
|
|
/// #[openapi(
|
|
|
|
|
/// paths(get_products),
|
|
|
|
|
/// components(schemas(Product))
|
|
|
|
|
/// )]
|
|
|
|
|
/// struct ApiDoc2;
|
2025-10-01 07:42:16 +02:00
|
|
|
///
|
2025-10-07 08:33:06 +02:00
|
|
|
/// #[utoipa::path(
|
|
|
|
|
/// get,
|
|
|
|
|
/// path = "/products",
|
|
|
|
|
/// responses((status = 200, description = "List products"))
|
|
|
|
|
/// )]
|
|
|
|
|
/// async fn get_products() -> Json<Vec<Product>> {
|
|
|
|
|
/// Json(vec![])
|
|
|
|
|
/// }
|
|
|
|
|
///
|
|
|
|
|
/// let api_router1 = Router::new().route("/users", get(get_users));
|
|
|
|
|
/// let api_router2 = Router::new().route("/products", get(get_products));
|
|
|
|
|
///
|
|
|
|
|
/// // Ajouter les deux API au serveur, chacune avec son nom unique
|
|
|
|
|
/// server.add_openapi(api_router1, ApiDoc1::openapi(), "api1").await;
|
|
|
|
|
/// server.add_openapi(api_router2, ApiDoc2::openapi(), "api2").await;
|
2025-10-01 07:42:16 +02:00
|
|
|
/// ```
|
2025-10-07 08:33:06 +02:00
|
|
|
///
|
|
|
|
|
/// Résultat :
|
|
|
|
|
///
|
2025-10-07 13:12:44 +02:00
|
|
|
/// - `/api/api1/users` et `/api/api2/products` sont accessibles via Axum.
|
2025-10-07 08:33:06 +02:00
|
|
|
/// - `/swagger-ui/api1` et `/swagger-ui/api2` affichent la documentation Swagger correspondante.
|
|
|
|
|
/// - `/api-docs/api1.json` et `/api-docs/api2.json` fournissent les spécifications OpenAPI respectives.
|
|
|
|
|
|
|
|
|
|
pub async fn add_openapi(
|
|
|
|
|
&mut self,
|
|
|
|
|
api_router: Router,
|
|
|
|
|
openapi: utoipa::openapi::OpenApi,
|
|
|
|
|
name: &str, // nom unique pour différencier Swagger et OpenAPI
|
|
|
|
|
) {
|
|
|
|
|
use axum::routing::get;
|
|
|
|
|
use utoipa_swagger_ui::SwaggerUi;
|
|
|
|
|
|
|
|
|
|
// Stocker le router API dans self.api_router si tu veux y accéder plus tard
|
2025-10-01 07:42:16 +02:00
|
|
|
let mut api_r = self.api_router.write().await;
|
2025-10-07 08:33:06 +02:00
|
|
|
*api_r = Some(api_router.clone());
|
|
|
|
|
|
|
|
|
|
// Générer des chemins uniques pour Swagger UI et OpenAPI JSON
|
|
|
|
|
let swagger_path = format!("/swagger-ui/{}", name);
|
|
|
|
|
let swagger_path_static: &'static str = Box::leak(swagger_path.into_boxed_str());
|
2025-10-01 07:42:16 +02:00
|
|
|
|
2025-10-07 08:33:06 +02:00
|
|
|
let openapi_json_path = format!("/api-docs/{}.json", name);
|
|
|
|
|
let openapi_json_path_static: &'static str = Box::leak(openapi_json_path.into_boxed_str());
|
2025-10-01 07:42:16 +02:00
|
|
|
|
2025-10-07 08:33:06 +02:00
|
|
|
let swagger = SwaggerUi::new(swagger_path_static).url(openapi_json_path_static, openapi);
|
2025-10-07 13:12:44 +02:00
|
|
|
|
|
|
|
|
// Nester le router API sous /api/{name}
|
|
|
|
|
let base_path = format!("/api/{}", name);
|
|
|
|
|
let nested_router = Router::new().nest(&base_path, api_router);
|
|
|
|
|
|
2025-10-07 08:33:06 +02:00
|
|
|
// Fusionner avec le router principal
|
2025-10-01 07:42:16 +02:00
|
|
|
let mut r = self.router.write().await;
|
2025-10-07 08:33:06 +02:00
|
|
|
let mut combined = std::mem::take(&mut *r);
|
2025-10-07 13:12:44 +02:00
|
|
|
combined = combined.merge(nested_router).merge(swagger);
|
2025-10-07 08:33:06 +02:00
|
|
|
*r = combined;
|
2025-10-01 07:42:16 +02:00
|
|
|
}
|
2025-09-23 20:54:50 +02:00
|
|
|
/// Démarre le serveur HTTP
|
|
|
|
|
///
|
|
|
|
|
/// Lance le serveur sur le port configuré et met en place la gestion
|
|
|
|
|
/// de Ctrl+C pour un arrêt gracieux.
|
|
|
|
|
///
|
|
|
|
|
/// # Exemple
|
|
|
|
|
///
|
|
|
|
|
/// ```rust,no_run
|
|
|
|
|
/// # use pmoupnp::server::Server;
|
|
|
|
|
/// # #[tokio::main]
|
|
|
|
|
/// # async fn main() {
|
|
|
|
|
/// # let mut server = Server::new("Test", "http://localhost:3000", 3000);
|
|
|
|
|
/// server.start().await;
|
|
|
|
|
/// server.wait().await; // Attend Ctrl+C
|
|
|
|
|
/// # }
|
|
|
|
|
/// ```
|
|
|
|
|
pub async fn start(&mut self) {
|
|
|
|
|
let addr = SocketAddr::from(([0, 0, 0, 0], self.http_port));
|
2025-10-07 08:33:06 +02:00
|
|
|
info!(
|
|
|
|
|
"Server {} running at [http://{}:{}](http://{}:{})",
|
|
|
|
|
self.name, self.base_url, self.http_port, self.base_url, self.http_port
|
|
|
|
|
);
|
2025-10-01 07:42:16 +02:00
|
|
|
|
|
|
|
|
// Merger le routeur API si présent
|
|
|
|
|
let api_router = self.api_router.read().await;
|
|
|
|
|
if let Some(api_r) = api_router.as_ref() {
|
|
|
|
|
let mut r = self.router.write().await;
|
|
|
|
|
*r = std::mem::take(&mut *r).nest("/api", api_r.clone());
|
|
|
|
|
}
|
|
|
|
|
drop(api_router);
|
2025-09-23 20:54:50 +02:00
|
|
|
|
|
|
|
|
let router = self.router.clone();
|
|
|
|
|
|
|
|
|
|
let server_task = tokio::spawn(async move {
|
|
|
|
|
let r = router.read().await.clone();
|
|
|
|
|
let listener = tokio::net::TcpListener::bind(addr).await.unwrap();
|
|
|
|
|
axum::serve(listener, r.into_make_service()).await.unwrap();
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
let shutdown_task = tokio::spawn(async move {
|
|
|
|
|
signal::ctrl_c().await.expect("failed to listen for ctrl_c");
|
|
|
|
|
info!("Ctrl+C reçu, arrêt gracieux");
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
self.join_handle = Some(tokio::spawn(async move {
|
|
|
|
|
tokio::select! {
|
|
|
|
|
_ = server_task => {},
|
|
|
|
|
_ = shutdown_task => {},
|
|
|
|
|
}
|
|
|
|
|
}));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Attend la fin du serveur
|
|
|
|
|
pub async fn wait(&mut self) {
|
|
|
|
|
if let Some(h) = self.join_handle.take() {
|
|
|
|
|
let _ = h.await;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Récupère les infos du serveur
|
|
|
|
|
pub fn info(&self) -> ServerInfo {
|
|
|
|
|
ServerInfo {
|
|
|
|
|
name: self.name.clone(),
|
|
|
|
|
base_url: self.base_url.clone(),
|
|
|
|
|
http_port: self.http_port,
|
|
|
|
|
}
|
|
|
|
|
}
|
2025-10-06 20:24:04 +02:00
|
|
|
|
|
|
|
|
/// Initialise le système de logging et enregistre les routes de logs
|
|
|
|
|
///
|
|
|
|
|
/// Cette méthode configure le système de tracing avec SSE et optionnellement la console,
|
|
|
|
|
/// puis enregistre automatiquement les routes `/log-sse` et `/log-dump`.
|
|
|
|
|
///
|
|
|
|
|
/// # Arguments
|
|
|
|
|
///
|
|
|
|
|
/// * `options` - Options de configuration du logging
|
|
|
|
|
///
|
|
|
|
|
/// # Exemple
|
|
|
|
|
///
|
|
|
|
|
/// ```rust,no_run
|
|
|
|
|
/// # use pmoserver::{ServerBuilder, logs::LoggingOptions};
|
|
|
|
|
/// # #[tokio::main]
|
|
|
|
|
/// # async fn main() {
|
|
|
|
|
/// let mut server = ServerBuilder::new_configured().build();
|
|
|
|
|
///
|
|
|
|
|
/// // Initialiser les logs avec console
|
|
|
|
|
/// server.init_logging(LoggingOptions::default()).await;
|
|
|
|
|
///
|
|
|
|
|
/// // Ou sans console
|
|
|
|
|
/// server.init_logging(LoggingOptions {
|
|
|
|
|
/// buffer_capacity: 1000,
|
|
|
|
|
/// enable_console: false,
|
|
|
|
|
/// }).await;
|
|
|
|
|
///
|
|
|
|
|
/// server.start().await;
|
|
|
|
|
/// # }
|
|
|
|
|
/// ```
|
|
|
|
|
pub async fn init_logging(&mut self, options: LoggingOptions) {
|
|
|
|
|
let log_state = init_logging(options);
|
|
|
|
|
|
|
|
|
|
// Enregistrer automatiquement les routes de logging
|
2025-10-07 08:33:06 +02:00
|
|
|
self.add_handler_with_state("/log-sse", log_sse, log_state.clone())
|
|
|
|
|
.await;
|
|
|
|
|
self.add_handler_with_state("/log-dump", log_dump, log_state.clone())
|
|
|
|
|
.await;
|
2025-10-06 20:24:04 +02:00
|
|
|
|
|
|
|
|
self.log_state = Some(log_state);
|
|
|
|
|
}
|
2025-09-23 20:54:50 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Builder pattern
|
|
|
|
|
pub struct ServerBuilder {
|
|
|
|
|
name: String,
|
|
|
|
|
base_url: String,
|
|
|
|
|
http_port: u16,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl ServerBuilder {
|
|
|
|
|
/// Crée un nouveau builder
|
|
|
|
|
///
|
|
|
|
|
/// # Arguments
|
|
|
|
|
///
|
|
|
|
|
/// * `name` - Nom du serveur
|
|
|
|
|
/// * `base_url` - URL de base (ex: "http://localhost:3000")
|
|
|
|
|
/// * `http_port` - Port HTTP
|
|
|
|
|
pub fn new(name: impl Into<String>, base_url: impl Into<String>, http_port: u16) -> Self {
|
|
|
|
|
Self {
|
|
|
|
|
name: name.into(),
|
|
|
|
|
base_url: base_url.into(),
|
|
|
|
|
http_port,
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
pub fn new_configured() -> Self {
|
|
|
|
|
let config = get_config();
|
|
|
|
|
Self {
|
|
|
|
|
name: "PMO-Music-Server".to_string(),
|
|
|
|
|
base_url: config.get_base_url(),
|
2025-10-07 08:33:06 +02:00
|
|
|
http_port: config.get_http_port(),
|
2025-09-23 20:54:50 +02:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Construit le serveur
|
|
|
|
|
///
|
|
|
|
|
/// Consomme le builder et retourne une instance de `Server` prête à l'emploi.
|
|
|
|
|
///
|
|
|
|
|
/// # Exemple
|
|
|
|
|
///
|
|
|
|
|
/// ```rust
|
|
|
|
|
/// # use pmoupnp::server::ServerBuilder;
|
|
|
|
|
/// let mut server = ServerBuilder::new("MyAPI", "http://localhost:3000", 3000)
|
|
|
|
|
/// .build();
|
|
|
|
|
/// ```
|
|
|
|
|
pub fn build(self) -> Server {
|
|
|
|
|
Server::new(self.name, self.base_url, self.http_port)
|
|
|
|
|
}
|
2025-10-07 08:33:06 +02:00
|
|
|
}
|