torrust-actix 4.1.2

A rich, fast and efficient Bittorrent Tracker.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

//! API authentication token query parameter.

use serde::{Deserialize, Serialize};

/// Query parameter struct for API authentication.
///
/// Used to extract the authentication token from the URL query string.
/// All API endpoints require a valid token for authentication.
///
/// # Example
///
/// Request: `GET /api/torrents?token=my_secret_key`
///
/// ```rust,ignore
/// async fn handler(query: Query<QueryToken>) -> HttpResponse {
///     if let Some(token) = &query.token {
///         // Validate token...
///     }
/// }
/// ```
#[derive(Debug, Serialize, Deserialize)]
pub struct QueryToken {
    /// The API authentication token (optional in struct, required for access).
    pub(crate) token: Option<String>,
}