mycelium-api 8.3.1-rc.1

Provide API ports to the mycelium project.
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
43
44
45
46
47
48
49
50
51
52
53
54
55

use actix_web::{get, web, HttpResponse, Responder};
use chrono::{Local, Utc};

// ? ---------------------------------------------------------------------------
// ? Configure application
// ? ---------------------------------------------------------------------------

pub fn configure(config: &mut web::ServiceConfig) {
    config.service(health_url).service(now_url);
}

// ? ---------------------------------------------------------------------------
// ? Define API paths
// ? ---------------------------------------------------------------------------

/// Provide a health check endpoint.
///
/// If the server is running it returns a 200 response with a JSON body
/// containing the success message.
#[utoipa::path(
    get,
    operation_id = "check_service_health",
    context_path = "/health",
    responses(
        (
            status = 200,
            description = "Health check passed.",
            body = String,
        ),
    ),
)]
#[get("")]
pub async fn health_url() -> impl Responder {
    HttpResponse::Ok().body("success".to_string())
}

/// Provide a datetime with the server's timezone.
///
/// This is usual during system checks.
#[utoipa::path(
    get,
    operation_id = "get_server_datetime",
    context_path = "/health",
    responses(
        (
            status = 200,
            description = "The current datetime with timezone.",
            body = String,
        ),
    ),
)]
#[get("/now")]
pub async fn now_url() -> impl Responder {
    HttpResponse::Ok().body(Utc::now().with_timezone(&Local).to_string())
}