sword-web 0.3.0

Web controllers and runtime for the Sword framework
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

use serde::{Deserialize, Serialize};
use sword_core::{ConfigItem, ConfigRegistrar, inventory_submit};
use sword_layers::{body_limit::BodyLimitConfig, timeout::RequestTimeoutConfig};

#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg(feature = "swagger-ui")]
pub struct OpenApiConfig {
    pub title: String,
    pub version: String,
    #[serde(default)]
    pub description: Option<String>,
    #[serde(rename = "spec-file-paths")]
    pub spec_file_paths: Vec<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(default)]
pub struct WebApplicationConfig {
    /// The hostname or IP address to bind the server to. Defaults to "0.0.0.0"
    pub host: String,

    /// The port number to bind the server to. Defaults to 8000
    pub port: u16,

    /// Optional global prefix for all web controller routes.
    #[serde(rename = "router-prefix")]
    pub router_prefix: Option<String>,

    #[cfg(feature = "swagger-ui")]
    #[serde(default)]
    /// Optional OpenAPI documentation configuration.
    pub openapi: Option<OpenApiConfig>,

    /// Body limit policy for web request extraction.
    #[serde(rename = "body-limit")]
    pub body_limit: BodyLimitConfig,

    /// Request timeout policy applied to web controllers.
    #[serde(rename = "request-timeout")]
    pub request_timeout: RequestTimeoutConfig,
}

impl Default for WebApplicationConfig {
    fn default() -> Self {
        Self {
            host: "0.0.0.0".to_string(),
            port: 8000,
            router_prefix: None,
            body_limit: BodyLimitConfig::default(),
            request_timeout: RequestTimeoutConfig::default(),
            #[cfg(feature = "swagger-ui")]
            openapi: None,
        }
    }
}

impl ConfigItem for WebApplicationConfig {
    fn key() -> &'static str {
        "web"
    }
}

inventory_submit! {[
    ConfigRegistrar::new(|state, config| {
        state.insert(config.get_or_default::<WebApplicationConfig>());
    })
]}