系统与系统之间的约定

路径、参数、鉴权和错误码写清楚,联调才不必靠猜。

{ "ok": true, "token": "Bearer ***", "version": "v1" }

页面、小程序、后台任务想互相说话,就要走接口。接口不是“能返回 JSON 就行”,而是一份可以执行的合同:谁能调、怎么调、失败时看见什么。

GET/资源路径用名词表达对象,用方法表达动作。/orders 和 /orders/8/pay 比 /doGetOrder 更容易被下一任理解。
POST/JSON 形状字段名稳定,时间格式统一,空值和缺省要有说法。今天少一个字段,客户端明天就会把 undefined 画到屏幕上。
PUT/鉴权Token、签名或会话证明“你是谁”。公开接口和内部接口必须分开,文档里也要写明过期和刷新。
PATCH/分页过滤列表不一次倒完。页码、游标、排序和筛选条件要可复现,导出和核对才对得上同一批数据。
DELETE/错误与版本错误码比一句“失败”有用。路径上留下版本,旧客户端才有时间搬家,而不是某天集体 404。