Files
ipass__ipass/rust/crates/plugin-apix/src/models.rs
T
admin 4533db8536 feat(apix): 透传模式 passthrough —— 通用内部 REST 出口 (1.0.20)
- 模型加 mode 字段(vendor 默认 / passthrough 新增),shm payload 扩为 4 字段
  base\nkey\nasset_id\nmode;旧数据零迁移(无 mode → vendor)
- 拆 location 而非按 mode 分支:/apixp/ 不施加 vendor 强约束
  (proxy_method POST + 强制 Content-Type + proxy_pass_request_headers off
  是 location 级指令,无法按请求级 shm 的 mode 动态切换)
- handler 校验路径前缀 vs mode 一致(vendor slug 走 /apixp/ → 404,反之亦然),
  避免 vendor 条目继承 passthrough 强制 Content-Type 致 415 之类静默故障
- passthrough:方法/请求体/Content-Type 原样透传(含 multipart),上游路径
  = base + /apixp/<slug> 之后的 URI 尾部(含 query 由模块拼,变量式 proxy_pass
  不自动追加);Key 可空(内部服务免鉴权,下发时 nginx 空串 = 不发该头)
- 探测按 mode 分流:vendor 走 POST 预估 / passthrough 走 GET 打上游根地址
- nginx:lm server 加 /apixp/,mdm server 加 /_apixp_probe/(internal)
- 测试 §11.6 新增 35 条断言(鉴权/路径转发/体透传/Key 下发/路径-mode 一致
  /管理台回显/探测);账号态 count 1→3 同步;回归 225/0 全绿
- 管理台:列表加 mode 标签、表单加 mode 下拉 + 透传说明 + 路径示例复制
- 文档:docs/apix/PASSTHROUGH_MODE.md 真源(决策/兼容/改动一览)

OCR 是第一条 passthrough 配置:/apixp/ocr/ocr、/apixp/ocr/ocr/base64、
/apixp/ocr/ocr/url?src=...
2026-09-15 10:51:29 +08:00

82 lines
3.3 KiB
Rust
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
//! API 代理持久化模型(`api-proxies.json`:以 slug 为 key)。
//!
//! 字段名与旧版 `data/api-proxies.json` **逐字对应**,以便新版直接接管旧数据文件。
use serde::{Deserialize, Serialize};
use std::collections::BTreeMap;
/// API 代理表(`api-proxies.json`)。
///
/// 与 `llm-upstreams.json` 同构:每条记录 = 一个供应商(自带基址与密钥),
/// 由 `slug` 区分。调用方访问 `/apix/<slug>?参数=值`,网关用本记录里的密钥
/// 转发到供应商、并把响应原样返回。不同供应商彼此独立、互不耦合。
///
/// `key` 是供应商真 Key,**敏感级别等同 `users.json`**(data/ 已 gitignore)。
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ApiProxyStore {
/// slug → 代理映射
#[serde(default)]
pub items: BTreeMap<String, ApiProxy>,
}
impl Default for ApiProxyStore {
fn default() -> Self {
Self { items: BTreeMap::new() }
}
}
/// 单个 API 代理条目:指向某一家供应商的一个可调用的资产。
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ApiProxy {
/// 供应商侧的资产 id(如 `searxng-search`),决定具体调用哪个资产。
/// **vendor 模式必填**;passthrough 模式用不到(上游路径由 URL 尾部决定),可留空。
pub asset_id: String,
/// 供应商名称(仅展示用,管理员自填,例如 `provider-x` / 客户自定)
#[serde(default)]
pub supplier: String,
/// 供应商基址,如 `https://api.example.com`
#[serde(default)]
pub base: String,
/// 供应商 API Key(`ak_...`)。留空 = 未配置,热路径直接 503。
/// **敏感**:写盘与回显都按密钥处理,管理台只回显掩码。
/// passthrough 模式下若上游不需要鉴权可留空(不下发任何鉴权头)。
#[serde(default)]
pub key: String,
/// 代理模式:
/// - `vendor`(默认):单一供应商收口 `POST {base}/api/v1/ai/request`,
/// 请求体由网关按 `asset_id` 拼装(见 `apix.rs`)。
/// - `passthrough`:透传模式,原样转发客户端的方法/请求体/Content-Type,
/// 上游路径 = `{base} + /apixp/<slug> 之后的 URI 尾部`,用于 OCR / 文生图 /
/// TTS 这类「多端点、多 body、无 asset 市场」的内部 REST 服务。
#[serde(default = "default_mode")]
pub mode: String,
/// 展示名(中文)
#[serde(default)]
pub name: String,
/// 一句话说明
#[serde(default)]
pub desc: String,
/// **声明式参数清单**(如 `["q"]`)。
///
/// 只用于给调用方看的文档(管理台把 `?q=关键词` 拼出来、账号态接口回显),
/// 转发时**不按它过滤**——过滤要靠读请求体,而 access 阶段读不到。
/// 供应商侧自己会拒绝不认识的参数,拦在网关意义不大。
#[serde(default)]
pub params: Vec<String>,
#[serde(default = "default_true")]
pub enabled: bool,
#[serde(default)]
pub note: String,
#[serde(default)]
pub created_at: i64,
}
fn default_true() -> bool {
true
}
/// 默认代理模式 = vendor(向后兼容旧数据:没有 `mode` 字段的条目就是 vendor)。
fn default_mode() -> String {
"vendor".to_owned()
}