接口与健康检查
这一页列出本地部署最常用的公开接口。接口细节以后会继续补充。
登录与当前用户
| 方法 | 路径 | 作用 |
|---|---|---|
POST | /api/setup/admin | 初始化本地管理员。 |
POST | /api/auth/login | 登录。 |
POST | /api/auth/logout | 退出登录。 |
GET | /api/auth/me | 查看当前登录状态。 |
订阅
| 方法 | 路径 | 作用 |
|---|---|---|
GET | /api/subscriptions | 读取订阅列表。 |
POST | /api/subscriptions | 创建订阅。 |
GET | /api/subscriptions/:id | 读取一个订阅。 |
PUT | /api/subscriptions/:id | 更新一个订阅。 |
DELETE | /api/subscriptions/:id | 删除一个订阅。 |
POST | /api/subscriptions/:id/refresh | 手动刷新订阅。 |
GET | /api/subscriptions/:token/config.yaml | 读取生成的 YAML。 |
模板与规则
| 方法 | 路径 | 作用 |
|---|---|---|
GET | /api/templates | 读取模板列表。 |
POST | /api/templates | 创建私有模板。 |
DELETE | /api/templates | 删除私有模板。 |
GET | /api/rules/search | 搜索规则。 |
GET | /api/rules/cn-candidates | 查找中国规则候选。 |
健康检查
| 方法 | 路径 | 作用 |
|---|---|---|
GET | /api/health/live | 应用进程是否存活。 |
GET | /api/health/ready | 数据库等依赖是否就绪。 |
