apikit 0.2.0

A toolkit for building HTTP APIs with 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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

//! Commonly used rejections and recovery procedures.
use std::fmt::Display;

use axum::http::StatusCode;

use axum::response::{IntoResponse, Response};

use miette::Diagnostic;
use serde::Serialize;

use crate::reply;

const MESSAGE_NOT_FOUND: &str = "not found";
const MESSAGE_FORBIDDEN: &str = "forbidden";
const MESSAGE_INTERNAL_SERVER_ERROR: &str = "internal server error";

#[derive(Debug, Diagnostic, Serialize)]
#[serde(untagged)]
pub enum HTTPError {
    BadRequest {
        error: String,
    },
    Forbidden,
    NotFound,
    InternalServerError {
        error: String,
        backtrace: Option<String>,
    },
}

impl Display for HTTPError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::BadRequest { error } => write!(f, "bad request: {}", error),
            Self::Forbidden => write!(f, "forbidden"),
            Self::NotFound => write!(f, "not found"),
            Self::InternalServerError {
                error,
                backtrace: Some(backtrace),
            } => write!(f, "internal server error: {}\n{}", error, backtrace),
            Self::InternalServerError {
                error,
                backtrace: None,
            } => write!(f, "internal server error: {}", error),
        }
    }
}

impl std::error::Error for HTTPError {}

impl HTTPError {
    pub fn bad_request<S: ToString>(s: S) -> Self {
        Self::BadRequest {
            error: s.to_string(),
        }
    }

    pub fn internal_server_error<E: ToString>(e: E) -> Self {
        Self::InternalServerError {
            error: e.to_string(),
            backtrace: None, // TODO: Properly capture backtrace
        }
    }
}

impl IntoResponse for HTTPError {
    fn into_response(self) -> Response {
        match self {
            Self::BadRequest { error } => reply::error(error, StatusCode::BAD_REQUEST),
            Self::Forbidden => reply::error(MESSAGE_FORBIDDEN, StatusCode::FORBIDDEN),
            Self::NotFound => reply::error(MESSAGE_NOT_FOUND, StatusCode::NOT_FOUND),
            Self::InternalServerError {
                ref error,
                ref backtrace,
            } => {
                if let Some(backtrace) = backtrace {
                    tracing::error!("{error}\n{backtrace}");
                } else {
                    tracing::error!("{error}");
                }
                reply::error(
                    MESSAGE_INTERNAL_SERVER_ERROR,
                    StatusCode::INTERNAL_SERVER_ERROR,
                )
            }
        }
    }
}