个人项目做久了,我越来越相信:API 先规范,后开发,返工会少一半。

先定三件事

  1. 统一响应结构(code、message、data)。
  2. 统一错误码,避免前端猜测错误原因。
  3. 统一分页参数,减少页面适配成本。

命名建议

  • 资源名用复数,如 /posts/users
  • 操作用 HTTP 动词表达,不要把动词塞进路径。
  • 版本号放在前缀,比如 /api/v1

接口设计草图

结论

API 的一致性比“聪明设计”更重要。简单、稳定、可预期,才是长期维护最友好的方案。