返回知识库

数据与服务 · 服务与数据

接口API

接口是前后端的约定窗口:按方法加路径去问,按状态码加 JSON 来答。

先认出这个服务窗口,再按约定问一次

下面就是前后端交界的窗口。默认已按 GET /orders/184 递出 200 回条。换未登录或方法不对,401 / 405 也盖在同一张回条上。

服务窗口200 OK

GET /orders/184

{ "id": 184, "total": 32, "item": "美式拿铁" }

方法 + 路径 = 这次要做的事;状态码 + JSON = 结果。

200 OK回条就是这次调用的结果。

原因:方法和路径对上了约定,窗口递出订单回条。下一步:试「未登录取 /me」,看 401 盖在同一张回条上。

知识点:接口是问法与答法的约定

回条上的状态码已经演示了核心关系,这里只给可复用的命名。

  • 一次调用 = 方法 + 路径;一次结果 = 状态码 + 正文(常见是 JSON)。
  • 成功和失败都要按约定返回,前端据此更新页面或提示重试。
  • 网络失败和业务失败要分开:没回条是通道问题,有 4xx 是约定拒绝。
  • 和 REST / GraphQL 的关系:它们是两种常见约定,窗口还是这扇窗。

什么时候用、怎么用

店面要保存、要拉列表、要登录,就走接口,而不是直接碰数据库。

  • 信号:点击后要和服务器交换数据,或要处理成功/失败两种结果。
  • 适用:下单、拉订单、读当前用户——任何跨进程的约定调用。
  • 不适用:纯前端状态、本机计算;也不要在失败时假装成功。
  • 最短路径:定方法与路径 → 发送 → 读状态码和 JSON → 成功更新物件,失败给可重试说明。

正反例:同一扇窗口,只换失败怎么回

目标都是取当前用户,只改没登录时窗口怎么答。

正例401 + 登录地址

回条写明 unauthorized 和 /login。店面去登录,不假装已取到用户。

反例失败也返回 200 空对象

店面以为成功,页面空白或写进脏数据。失败必须写在回条状态码上。

快速自测

保存订单时网络断开,页面该怎样对用户说?

继续查证

术语的技术定义和行为以这些一手或权威资料为准。

下一步学

和本知识点经常一起出现的概念。