vane 0.9.2

A flow-based reverse proxy with multi-layer routing and programmable pipelines.
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

/* src/api/response.rs */

use axum::{
	http::StatusCode,
	response::{IntoResponse, Json, Response},
};
use serde::Serialize;

// A generic structure for all API responses (Runtime only, no ToSchema here).
#[derive(Serialize)]
pub struct ApiResponse<T: Serialize> {
	pub status: &'static str,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub data: Option<T>,
	#[serde(skip_serializing_if = "Option::is_none")]
	pub message: Option<String>,
}

/// Creates a successful (200 OK) API response.
pub fn success<T: Serialize>(data: T) -> Response {
	let response = ApiResponse {
		status: "success",
		data: Some(data),
		message: None,
	};
	(StatusCode::OK, Json(response)).into_response()
}

/// Creates a created (201 Created) API response.
pub fn created<T: Serialize>(data: T) -> Response {
	let response = ApiResponse {
		status: "success",
		data: Some(data),
		message: None,
	};
	(StatusCode::CREATED, Json(response)).into_response()
}

/// Creates an error API response.
#[must_use]
pub fn error(status_code: StatusCode, message: String) -> Response {
	let response = ApiResponse::<()> {
		status: "error",
		data: None,
		message: Some(message),
	};
	(status_code, Json(response)).into_response()
}