网站API设计:前后端协作的契约

网站建设 · 超级管理员

网站API设计:前后端协作的契约

前端和后端不是一个人写,靠 API 当契约。契约写得烂,联调能吵一周。

规范:《统一返回结构》(code/message/data)、《错误码有文档》、字段命名前后端约定(别一个叫 user_id 一个叫 uid)、大版本加 /v1 前缀方便迭代。廷云信息定项目必写接口文档,前后端对着文档开发,联调顺畅。改接口要通知对方,别偷偷改字段名。API 是团队协作的地基。

文档先行,吵架减半。