update doc
This commit is contained in:
1 parent
90525cdfd8
commit
bdbfa90e89
1 file changed
+7
-63
@@ -5,7 +5,7 @@
|
||||
## ✨ 特性
|
||||
|
||||
- 🚀 **基于 Cloudflare Workers**:无服务器架构,全球边缘部署
|
||||
- 🔐 **多渠道支持**:支持 Azure OpenAI 等多种 AI 服务提供商
|
||||
- 🔐 **多渠道支持**:目前支持 Azure OpenAI,后续会继续增加其他 AI 服务提供商
|
||||
- 🎫 **Token 管理**:完整的 API Token 生成、管理和配额控制
|
||||
- 📊 **使用量统计**:实时统计 API 使用量和费用
|
||||
- 💰 **定价管理**:灵活的模型定价配置
|
||||
@@ -43,14 +43,14 @@ awsl-one-api/
|
||||
|
||||
```text
|
||||
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
|
||||
│ 客户端应用 │───▶│ AWSL One API │───▶│ AI 服务商 │
|
||||
│ Client Apps │───▶│ AWSL One API │───▶│ AI Providers │
|
||||
│ │ │ (CF Workers) │ │ (Azure OpenAI) │
|
||||
└─────────────────┘ └─────────────────┘ └─────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────┐
|
||||
│ Cloudflare D1 │
|
||||
│ 数据库 │
|
||||
│ Database │
|
||||
└─────────────────┘
|
||||
```
|
||||
|
||||
@@ -90,7 +90,7 @@ run_worker_first = true
|
||||
|
||||
[[d1_databases]]
|
||||
binding = "DB"
|
||||
database_name = "awsl-one-api"
|
||||
database_name = "your-database-name"
|
||||
database_id = "your-database-id"
|
||||
```
|
||||
|
||||
@@ -109,29 +109,20 @@ pnpm dev
|
||||
### 部署到生产环境
|
||||
|
||||
```bash
|
||||
pnpm deploy
|
||||
pnpm run deploy
|
||||
```
|
||||
|
||||
## 📖 使用指南
|
||||
|
||||
### 初始化数据库
|
||||
|
||||
首次部署后,需要初始化数据库。可以通过以下方式之一:
|
||||
|
||||
#### 方式一:Web 界面(推荐)
|
||||
首次部署后,需要通过 Web 界面初始化数据库:
|
||||
|
||||
1. 访问 `https://your-domain.com`
|
||||
2. 使用管理员 Token 登录
|
||||
3. 切换到 **📊 数据库** 标签
|
||||
4. 点击 **🔄 初始化数据库** 按钮
|
||||
|
||||
#### 方式二:API 调用
|
||||
|
||||
```bash
|
||||
curl -X POST https://your-domain.com/api/admin/db_initialize \
|
||||
-H "x-admin-token: your-admin-token"
|
||||
```
|
||||
|
||||
### 频道配置
|
||||
|
||||
1. 在 Web 界面切换到 **🔗 频道管理** 标签
|
||||
@@ -206,58 +197,11 @@ curl https://your-domain.com/v1/chat/completions \
|
||||
- **智能表单**:自动生成 Token、JSON 格式验证、一键复制功能
|
||||
- **安全认证**:管理员 Token 认证,数据安全保护
|
||||
|
||||
### API 管理接口
|
||||
|
||||
所有管理 API 需要在请求头中包含 `x-admin-token`。
|
||||
|
||||
#### 数据库管理
|
||||
|
||||
```bash
|
||||
# 初始化数据库
|
||||
POST /api/admin/db_initialize
|
||||
```
|
||||
|
||||
#### 频道管理
|
||||
|
||||
```bash
|
||||
# 获取频道列表
|
||||
GET /api/admin/channel
|
||||
|
||||
# 创建/更新频道
|
||||
POST /api/admin/channel/{key}
|
||||
|
||||
# 删除频道
|
||||
DELETE /api/admin/channel/{key}
|
||||
```
|
||||
|
||||
#### Token 管理
|
||||
|
||||
```bash
|
||||
# 获取 Token 列表
|
||||
GET /api/admin/token
|
||||
|
||||
# 创建/更新 Token
|
||||
POST /api/admin/token/{key}
|
||||
|
||||
# 删除 Token
|
||||
DELETE /api/admin/token/{key}
|
||||
```
|
||||
|
||||
#### 定价管理
|
||||
|
||||
```bash
|
||||
# 获取定价配置
|
||||
GET /api/admin/pricing
|
||||
|
||||
# 更新定价配置
|
||||
POST /api/admin/pricing
|
||||
```
|
||||
|
||||
## 🔧 配置说明
|
||||
|
||||
### 渠道配置
|
||||
|
||||
支持多种 AI 服务提供商的配置,以 Azure OpenAI 为例:
|
||||
目前支持 Azure OpenAI 服务提供商的配置:
|
||||
|
||||
```json
|
||||
{
|
||||
|
||||
Reference in new issue
Block a user