专注 Web 开发技术与站长成长 · 让好内容被看见 首页 关于我们 RSS
公告 飞天站长WEB开发社区为广大的站长和广大WEB开发工作者提供技术文章等网站建设相关资源,以及站长建站经验的交流平台。

REST API 设计:让接口好用又好用

一个好的 API 应该让调用方”猜得到”下一步怎么请求。本文总结几条经过验证的设计原则。

资源导向与 HTTP 语义

用名词表示资源(/articles),用 HTTP 方法表示动作:GET 查询、POST 创建、PUT 更新、DELETE 删除。

状态码要准确:200 成功、201 已创建、400 参数错误、401 未认证、404 不存在、500 服务错误。

版本化与分页

在 URL 中加入版本号(/api/v1/),方便未来平滑升级。列表接口统一返回 page、per_page、total,调用方体验一致。