Skip to content

docs(architecture): correct the ops method, the transaction types and the API list scope #203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
argszero merged 1 commit into from
Sep 13, 2026
Merged

docs(architecture): correct the ops method, the transaction types and the API list scope #203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ cargo run # 首次自动创建 ./data/ 与配置，打开 http://localhost:808

### 接入方式

OpenAI 兼容网关端点：`POST /v1/chat/completions`、`POST /v1/responses`、`POST /anthropic/v1/messages`、`GET /v1/models`。接入地址在设置页展示，由 `[server].public_url` 配置（生产请设为真实域名）。API 全清单见 [docs/architecture.md](docs/architecture.md)。
OpenAI 兼容网关端点：`POST /v1/chat/completions`、`POST /v1/responses`、`POST /anthropic/v1/messages`、`GET /v1/models`。接入地址在设置页展示，由 `[server].public_url` 配置（生产请设为真实域名）。API 一览见 [docs/architecture.md](docs/architecture.md)，权威清单以 `src/routes/mod.rs` 的 `router()` 为准。

## 文档

Expand Down
10 changes: 8 additions & 2 deletions docs/architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,16 @@
| `models` | 模型价格（input / output / cache_hit，可选高峰价；config `[[models]]` 为唯一真源） |
| `quotas` | 点数账户（balance 永久 + gift_balance 有效赠送） |
| `gift_grants` | 赠送明细（amount / expires_at / status: active\|used\|expired） |
| `transactions` | 交易流水（type: consume\|earn\|topup\|gift；含 token 明细列） |
| `transactions` | 交易流水（type 取值以 `src/routes/wallet.rs` 的 `TX_FILTER_TYPES` 为准；含 token 明细列） |
| `usage_records` | 调用明细（tokens 拆 input / cached / output） |
| `departments` / `raise_requests` | 部门 + 成员加额申请（企业版） |
| `email_verifications` | 注册邮箱验证码（与 `users.verified` 配套，v6 起） |
| `schema_version` | 迁移记录（当前 v12，见 `src/db.rs` 的 `SCHEMA_VERSION`） |

## 6. API 一览

> 本表按**功能面**归纳，不是逐条路由的完整清单；权威清单以 `src/routes/mod.rs` 的 `router()` 为准。

- `GET /healthz` — 健康检查（返回版本号）
- `POST /api/auth/register` / `login` / `verify` / `resend-code` / `forgot` / `change-password`
- `GET /api/me` — 当前用户
Expand All @@ -72,7 +76,9 @@
- `GET /api/wallet` / `/api/transactions` / `/api/dashboard` — 钱包 / 交易（summary + 明细）/ 仪表盘
- `POST/GET/PATCH /api/sharings` — key 上架 / 列表 / 暂停下线
- `POST /api/admin/credits` / `GET /api/admin/users` / `usage` / `models` CRUD — 管理（role=admin）
- `GET /api/ops/runtime` / `credits` / `users` — 运营者视图（role=ops）
- `GET/POST /api/admin/departments` + `PATCH/DELETE /api/admin/departments/:id` — 部门管理（role=admin）
- `POST/GET /api/raise-requests` + `POST /api/admin/raise-requests/:id/{approve,reject}` — 加额申请 / 审批
- `GET /api/ops/runtime` / `users`，`POST /api/ops/credits` — 运营者视图（role=ops）
- `GET /api/config` — 前端动态配置（public_url 等）

## 7. 部署
Expand Down
Loading