Skip to content

Latest commit

 

History

History
152 lines (100 loc) · 4.89 KB

developer-workflows.md

File metadata and controls

152 lines (100 loc) · 4.89 KB

HeyBlog 开发者任务索引

适合谁看

  • 已经知道仓库大致结构,但想快速找到“这类任务从哪里下手”的开发者
  • 想减少在多份文档之间来回跳转的读者

建议前置阅读

不包含什么

最后核对源码入口

1. 我要新增或调整公共 API

先看:

通常改动顺序:

  1. 在 backend/main.py 增加或调整公共 /api/* 路由。
  2. 如果需要下游能力,再去改 crawler、search 或 persistence-api 的 /internal/*。
  3. 同步更新前端 API 封装与调用页面。
  4. 同步更新 api-docs.md。

2. 我要调 crawler

先看:

常见落点:

3. 我要查 graph 链路

先看:

判断原则:

  • 图数据的事实来源和视图组装在 persistence-api
  • backend 负责把这些能力暴露成公共 /api/graph*
  • 前端只负责参数组织、交互和渲染

如果你要讨论未来能力规划,再看:

4. 我要看搜索索引链路

先看:

链路顺序:

backend 在 health 检查、crawl run、runtime batch、database reset 后触发 search 读/重建索引 -> search 读取 search-index.json,缓存为空时回退到 persistence-api /internal/search-snapshot

5. 我要调 runtime / 控制台

先看:

重点记住:

  • 运行器状态保存在 crawler 进程内存里
  • backend 只负责把 runtime 能力暴露成公共接口
  • 重置数据库前,backend 会先检查 runtime 是否忙碌

6. 我要重置数据或理解本地状态

先看:

相关状态位置:

  • SQLite:data/heyblog.sqlite
  • 导出目录:data/exports/ 或 volumes/exports/
  • 搜索缓存:data/search-cache/ 或 volumes/search-cache/
  • PostgreSQL 卷:volumes/postgres/

7. 我要改前端页面

先看:

如果页面需要新数据:

  1. 先确认公共 API 是否已经存在。
  2. 没有的话,回到“我要新增或调整公共 API”这条流程。

8. 我要查配置或运行异常

先看:

优先核对:

  • 服务基地址是否指到了正确端口
  • 本地 uvicorn 启动时是否把 Docker 默认主机名改成了 127.0.0.1
  • HEYBLOG_DB_DSN 是否意外覆盖了 SQLite 模式

9. 常用配套文档