接口设计规范

接口设计约定

命名

• 资源用复数名词：/api/posts
• 动作用子路径：/api/posts/{id}/publish

返回结构

统一使用以下结构：

{
  "ok": true,
  "data": {},
  "message": ""
}

错误码

数据库约定

命名

• 表名复数、小写、下划线分隔
• 时间字段统一 created_at / updated_at

索引

外键与常用筛选字段必须建索引：

CREATE INDEX idx_posts_status ON posts(status, published_at DESC);

注意：字段类型不匹配会让索引失效，这是最常见的问题。

日志

• 业务操作写 activity_logs
• 异常走标准错误日志，不要把堆栈返回给前端