mirror of
https://github.com/xxnuo/MTranServer.git
synced 2026-05-07 05:56:12 +08:00
82 lines
2.8 KiB
Markdown
82 lines
2.8 KiB
Markdown
# MTranServer 高级配置说明
|
|
|
|
[中文](API.md) | [English](docs/API_en.md) | [日本語](docs/API_ja.md) | [Français](docs/API_fr.md) | [Deutsch](docs/API_de.md)
|
|
|
|
### 环境变量配置
|
|
|
|
| 环境变量 | 说明 | 默认值 | 可选值 |
|
|
| --------------------- | ---------------------------------------- | ------ | --------------------------- |
|
|
| MT_LOG_LEVEL | 日志级别 | warn | debug, info, warn, error |
|
|
| MT_CONFIG_DIR | 配置目录 | ~/.config/mtran/server | 任意路径 |
|
|
| MT_MODEL_DIR | 模型目录 | ~/.config/mtran/models | 任意路径 |
|
|
| MT_HOST | 服务器监听地址 | 0.0.0.0| 任意 IP 地址 |
|
|
| MT_PORT | 服务器端口 | 8989 | 1-65535 |
|
|
| MT_ENABLE_UI | 启用 Web UI | true | true, false |
|
|
| MT_OFFLINE | 离线模式，不自动下载新语言的模型，仅使用已下载的模型 | false | true, false |
|
|
| MT_WORKER_IDLE_TIMEOUT| Worker 空闲超时时间（秒） | 300 | 任意正整数 |
|
|
| MT_API_TOKEN | API 访问令牌 | 空 | 任意字符串 |
|
|
| MT_CACHE_SIZE | 缓存大小（缓存最近的多少次翻译） | 0 | 任意正整数 |
|
|
|
|
示例：
|
|
|
|
```bash
|
|
# 设置日志级别为 debug
|
|
export MT_LOG_LEVEL=debug
|
|
|
|
# 设置端口为 9000
|
|
export MT_PORT=9000
|
|
|
|
# 启动服务
|
|
./mtranserver
|
|
```
|
|
|
|
### API 接口说明
|
|
|
|
#### 系统接口
|
|
|
|
| 接口 | 方法 | 说明 | 认证 |
|
|
| ---- | ---- | ---- | ---- |
|
|
| `/version` | GET | 获取服务版本 | 否 |
|
|
| `/health` | GET | 健康检查 | 否 |
|
|
| `/__heartbeat__` | GET | 心跳检查 | 否 |
|
|
| `/__lbheartbeat__` | GET | 负载均衡心跳检查 | 否 |
|
|
| `/docs/*` | GET | Swagger API 文档 | 否 |
|
|
|
|
#### 翻译接口
|
|
|
|
| 接口 | 方法 | 说明 | 认证 |
|
|
| ---- | ---- | ---- | ---- |
|
|
| `/languages` | GET | 获取支持的语言列表 | 是 |
|
|
| `/translate` | POST | 单文本翻译 | 是 |
|
|
| `/translate/batch` | POST | 批量翻译 | 是 |
|
|
|
|
**单文本翻译请求示例：**
|
|
|
|
```json
|
|
{
|
|
"from": "en",
|
|
"to": "zh-Hans",
|
|
"text": "Hello, world!",
|
|
"html": false
|
|
}
|
|
```
|
|
|
|
**批量翻译请求示例：**
|
|
|
|
```json
|
|
{
|
|
"from": "en",
|
|
"to": "zh-Hans",
|
|
"texts": ["Hello, world!", "Good morning!"],
|
|
"html": false
|
|
}
|
|
```
|
|
|
|
**认证方式：**
|
|
|
|
- Header: `Authorization: Bearer <token>`
|
|
- Query: `?token=<token>`
|
|
|
|
|
|
详细内容请参考服务器启动后的 API 文档内容。
|