4a4349e0b9
- 修复文档中的格式问题和错误 - 新增功能文档：数据迁移和管理后台 - 调整文档目录结构，将管理后台移至功能分类 - 更新API文档中的字段说明和响应示例 - 优化后端配置文档，移除冗余内容
56 lines
2.2 KiB
Markdown
56 lines
2.2 KiB
Markdown
# API 概览
|
||
|
||
## 基础信息
|
||
|
||
- **接口地址**：`https://your-worker-api.workers.dev` 或你的自定义域名
|
||
- **数据格式**：JSON
|
||
- **字符编码**：UTF-8
|
||
|
||
所有 API 均为 RESTful 风格，无会话 Cookie，认证全部通过 `Authorization` 请求头完成。
|
||
|
||
## 版本信息
|
||
部署成功后，直接访问 Base URL，成功时返回 HTML，其中包含类似文案：
|
||
|
||
```text
|
||
CWD 评论部署成功，当前版本 v0.0.1
|
||
```
|
||
|
||
## 鉴权方式
|
||
|
||
公开接口与管理员接口的鉴权要求不同：
|
||
|
||
- 公开接口（Public API）
|
||
- `/api/comments`
|
||
- `/api/config/comments`
|
||
- 默认无需认证，可直接访问。
|
||
- 管理员接口（Admin API）
|
||
- 路径前缀：`/admin/*`
|
||
- 除 `/admin/login` 外，其余接口都需要携带管理员 Token。
|
||
|
||
管理员接口需要使用 Bearer Token 认证：
|
||
|
||
```http
|
||
Authorization: Bearer <token>
|
||
```
|
||
|
||
Token 通过登录接口获取，有效期为 24 小时，服务端会在 KV 中存储会话信息并在每次请求时进行校验。
|
||
|
||
## HTTP 状态码
|
||
|
||
常见状态码及含义如下：
|
||
|
||
| 状态码 | 说明 | 典型场景 |
|
||
| ------ | ---------------------------- | --------------------------------------------------- |
|
||
| 200 | 请求成功 | 正常查询、操作成功 |
|
||
| 400 | 请求参数错误 | 缺少必填字段、格式不正确等 |
|
||
| 401 | 未授权 | 未携带 Token 或 Token 失效 |
|
||
| 403 | 禁止访问 | 登录失败次数过多导致 IP 被暂时封禁 |
|
||
| 404 | 资源不存在（当前未显式使用） | 预留给未来可能的资源不存在场景 |
|
||
| 429 | 请求过于频繁 | 评论频率超过限制（默认同一 IP 10 秒内只能评论一次） |
|
||
| 500 | 服务器内部错误 | 未捕获异常、数据库错误等 |
|
||
|
||
具体到每个接口的详细请求 / 响应体和错误码，请参考：
|
||
|
||
- [公开 API](./public.md)
|
||
- [管理员 API](./admin.md)
|