terracotta 0.4.2

Boilerplate webserver application based on Axum
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

#![allow(clippy::exhaustive_structs, reason = "Handlers have auto-generated OpenAPI documentation")]
#![allow(clippy::unused_async,       reason = "Handler functions need to be async")]

//! Health check endpoints.



//		Modules																											

#[cfg(test)]
#[path = "tests/handlers.rs"]
mod tests;



//		Packages																										

use super::responses::HealthVersionResponse;
use axum::Json;



//		Functions																										

//		get_ping																
/// Availability check.
/// 
/// This endpoint is designed for use with uptime monitors. It simply returns
/// a 200 code and no content.
/// 
#[cfg_attr(feature = "utoipa", utoipa::path(
	get,
	path = "/api/ping",
	tag  = "health",
	responses(
		(status = 200, description = "Availability check"),
	),
))]
pub async fn get_ping() {}

//		get_version																
/// Current version.
/// 
/// This endpoint returns the current version of the API.
/// 
#[cfg_attr(feature = "utoipa", utoipa::path(
	get,
	path = "/api/version",
	tag  = "health",
	responses(
		(status = 200, description = "Current version retrieved successfully"),
	),
))]
pub async fn get_version() -> Json<HealthVersionResponse> {
	Json(HealthVersionResponse {
		version: env!("CARGO_PKG_VERSION").to_owned(),
	})
}