写给个人项目的 API 设计小清单
个人项目做久了,我越来越相信:API 先规范,后开发,返工会少一半。
先定三件事
- 统一响应结构(code、message、data)。
- 统一错误码,避免前端猜测错误原因。
- 统一分页参数,减少页面适配成本。
命名建议
- 资源名用复数,如
/posts、/users。 - 操作用 HTTP 动词表达,不要把动词塞进路径。
- 版本号放在前缀,比如
/api/v1。
结论
API 的一致性比“聪明设计”更重要。简单、稳定、可预期,才是长期维护最友好的方案。
本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来源 Dream of Soul Room!