aiway-protocol 0.1.0

The aiway protocol lib
Documentation
use crate::gateway::plugin::ConfiguredPlugin;
use serde::{Deserialize, Serialize};
use std::collections::BTreeMap;
use std::str::FromStr;

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct Route {
    /// 名称
    pub name: String,
    /// Host,可选,* 代表不限制。
    /// 支持泛域名,格式为 *.example.com,通配符只能出现在域名开头,需要在控制台校验。
    pub host: String,
    /// 路径,支持通配符,必须以"/"开头,全局唯一。
    /// 同一域名下的路径不能存在冲突,如/api/*和/api/**就是冲突的路径,在控制台保存时需要校验。
    /// 所有为 * 的域名下的路径也不能冲突。
    pub path: String,
    /// 转换后的匹配路径。
    /// 由于路径匹配组件使用的是`matchit`,格式为`/xxx/{*any}`,
    /// 它不符合常用的`/api/**`的格式,而`path`储存的是常用格式,
    /// 所以这里需要做一次转换。
    pub match_path: String,
    /// 需要路由到的服务ID
    pub service: String,
    /// 请求方法:get | post | put | delete | patch | options
    /// 支持配置多个。
    /// 不参与路由唯一性验证。
    pub methods: Vec<String>,
    /// header匹配条件
    /// 不参与路由唯一性验证。
    #[serde(alias = "header_condition", alias = "header-condition")]
    pub header: BTreeMap<String, String>,
    /// query匹配条件
    /// 不参与路由唯一性验证。
    #[serde(alias = "query_condition", alias = "query-condition")]
    pub query: BTreeMap<String, String>,
    /// 前置过滤器插件,在请求阶段执行,多个按顺序串联执行
    #[serde(default = "Vec::default", alias = "pre_filters", alias = "pre-filters")]
    pub pre_filters: Vec<ConfiguredPlugin>,
    /// 后置过滤器插件,在响应阶段执行,多个按顺序串联执行
    #[serde(
        default = "Vec::default",
        alias = "post_filters",
        alias = "post-filters"
    )]
    pub post_filters: Vec<ConfiguredPlugin>,
    /// 是否开启鉴权
    ///
    /// 备注:网关本身只支持API Key鉴权即可,如果需要其他类型的鉴权方式,可将此处鉴权关闭,然后通过插件实现。
    /// 考虑提供一些内置的鉴权插件。
    #[serde(default = "bool::default", alias = "is_auth", alias = "is-auth")]
    pub is_auth: bool,
    /// 鉴权路径白名单
    pub auth_white_list: Vec<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RewriteRule {
    /// 匹配模式(正则表达式)
    pub pattern: String,
    /// 替换字符串
    pub replacement: String,
}
impl Route {
    pub fn get_service(&self) -> &String {
        &self.service
    }

    /// 构建请求路径
    ///
    /// - path 原始的请求路径
    ///
    /// 能执行到这里,说明已经匹配到该路由了。
    /// (废弃,由插件实现)根据`strip_prefix`决定是否移除前缀
    pub fn build_path(&self, path: &str) -> String {
        /*let rewritten_path = self.apply_path_rewrite(path);*/
        path.to_string()
    }

    /*pub fn apply_path_rewrite(&self, path: &str) -> String {
        if let Some(rules) = &self.rewrite_rules {
            let mut result = path.to_string();
            for rule in rules {
                if let Ok(regex) = regex::Regex::new(&rule.pattern) {
                    result = regex.replace_all(&result, &rule.replacement).to_string();
                }
            }
            result
        } else {
            path.to_string()
        }
    }*/
}