技术学习笔记
← 返回笔记
后端开发·2026/9/2·1 分钟阅读

API 设计中的几个基本原则

从资源建模、状态码和幂等性三个角度,整理日常 API 设计中的判断标准。

先建模,再设计路径

API 路径应尽量表达资源,而不是表达动作。例如使用 POST /orders 创建订单,而不是 POST /createOrder。

正确使用状态码

状态码是客户端理解服务端结果的一部分。成功、客户端错误和服务端错误应保持稳定且可预测。

关注幂等性

支付、扣库存等操作需要通过幂等键或业务约束,确保网络重试不会导致重复执行。