API 开发

API 开发

这部分记录如何把文档、任务定义和运行时代码串起来。

约定

  • 路由保持稳定
  • 返回值尽量结构化
  • 输入输出边界清晰
  • 报错信息要可读

组织方式

src/
  app/
  lib/
  providers/
  workers/
content/
  docs/

变更检查

  1. 是否影响文档路由
  2. 是否影响构建产物
  3. 是否需要同步示例文档
  4. 是否增加了新的依赖