torrust-tracker 3.0.0

A feature rich BitTorrent tracker.
Documentation 
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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

//! API routes for the [`auth_key`](crate::servers::apis::v1::context::auth_key)
//! API context.
//!
//! - `POST /key/:seconds_valid`
//! - `DELETE /key/:key`
//! - `GET /keys/reload`
//!
//! Refer to the [API endpoint documentation](crate::servers::apis::v1::context::auth_key).
use std::sync::Arc;

use axum::routing::{get, post};
use axum::Router;

use super::handlers::{add_auth_key_handler, delete_auth_key_handler, generate_auth_key_handler, reload_keys_handler};
use crate::core::Tracker;

/// It adds the routes to the router for the [`auth_key`](crate::servers::apis::v1::context::auth_key) API context.
pub fn add(prefix: &str, router: Router, tracker: Arc<Tracker>) -> Router {
    // Keys
    router
        .route(
            // code-review: Axum does not allow two routes with the same path but different path variable name.
            // In the new major API version, `seconds_valid` should be a POST form field so that we will have two paths:
            //
            // POST /keys
            // DELETE /keys/:key
            //
            // The POST /key/:seconds_valid has been deprecated and it will removed in the future.
            // Use POST /keys
            &format!("{prefix}/key/:seconds_valid_or_key"),
            post(generate_auth_key_handler)
                .with_state(tracker.clone())
                .delete(delete_auth_key_handler)
                .with_state(tracker.clone()),
        )
        // Keys command
        .route(
            &format!("{prefix}/keys/reload"),
            get(reload_keys_handler).with_state(tracker.clone()),
        )
        .route(&format!("{prefix}/keys"), post(add_auth_key_handler).with_state(tracker))
}