本文档只描述当前代码中已经接入启动链路的模块和接口分组,不把历史设想或未来规划混进来。
| 模块 | 路径/端口 | 说明 |
|---|---|---|
| 健康检查 | GET /healthz |
存活探针 |
| 就绪检查 | GET /readyz |
就绪探针 |
| 指标端点 | :9091/metrics |
Prometheus 指标 |
| 模块 | 路由前缀 | 当前能力 |
|---|---|---|
| 用户与认证 | /api/user |
注册、登录、短信登录、发送短信验证码、发送邮件验证码、刷新令牌、登出、修改密码、注销、资料查询、资料更新、用户列表、权限码查询 |
| 帖子 | /api/posts |
草稿编辑、更新、发布、撤回、删除、个人列表、公开列表、全部列表、详情、公开详情、帖子计数、按版块筛选 |
| 评论 | /api/comments |
创建评论、删除评论、评论列表、更多回复、顶部回复 |
| 互动关系 | /api/relations |
关注、取消关注、粉丝列表、关注列表、关注数、粉丝数 |
| 浏览历史 | /api/history |
历史列表、删除单条、清空历史 |
| 最近活动 | /api/activity |
最近活动查询 |
| 版块 | /api/plate |
创建、更新、删除、列表 |
| 搜索 | /api/search |
搜索用户、帖子、评论 |
| 热榜 | /api/raking |
热榜查询、热榜配置查询、重算热榜 |
| 抽奖 | /api/lottery |
活动列表、创建、详情、参与 |
| 秒杀 | /api/secondKill |
活动列表、创建、详情、参与 |
说明:
- 热榜接口前缀当前代码里是
/api/raking,文档按实现保留该拼写。 - 搜索能力依赖 Elasticsearch。
| 模块 | 路由前缀 | 当前能力 |
|---|---|---|
| 审核 | /api/checks |
审核列表、详情、通过、驳回 |
| 角色 | /api/roles |
角色列表、创建、更新、删除、用户角色查询 |
| 权限分配 | /api/permissions |
单用户/批量用户角色分配 |
| 菜单 | /api/menus |
菜单列表、创建、更新、删除 |
| API 资源 | /api/apis |
API 资源列表、创建、更新、删除 |
当前仓库不只是同步 HTTP API,还包含一套事件和任务链路。
- 帖子阅读事件
- 帖子发布事件
- 评论发布事件
- 审核事件
- 短信事件
- 邮件事件
- Elasticsearch 同步消费
- 多条死信队列消费链路
- 帖子缓存刷新任务
- 定时任务分发
- 热榜刷新任务,当前通过 Scheduler 每小时触发一次
- 发布内容会进入审核链路
- 当
ark_api.provider != ark或没有配置ark_api.key时,AI 审核会回退到本地敏感词过滤 - 审核失败或异常内容会进入人工审核数据流
- 短信和邮件能力通过 producer/consumer 形式异步处理
- 默认 provider 为
mock - 切换真实 provider 时需要同步配置密钥
- 当前项目内置热榜查询接口
- Scheduler 当前按
@every 1h调度热榜刷新
以下内容不作为“当前代码已完整支持”的承诺:
- 第三方登录
- 私信系统
- 好友系统
- 移动端能力
- 复杂高级搜索界面
- 依赖 MongoDB 的主业务链路
如果要确认某项能力是否真的可用,以 internal/api/、internal/service/ 和启动链路中的实际注册为准。