术语 · 后端

接口端点

Endpoint

API 中处理某一类请求的具体地址,例如 /api/search。

一本菜单,一道道菜

同一个地址

方法GETPOST

路径/orders

一个地址,两个动作
方法不同,就是菜单上不同的菜
一个 API 由许多 endpoint 组成——地址加方法,唯一定位其中一个。

换个角度想

如果 API 是整本菜单,Endpoint 就是菜单上的一道菜:/orders 是「订单」这道菜,GET 是看一份、POST 是来一份——地址加动作,唯一确定你点的是什么。

一个地址,怎么装下查和建?

  1. 按资源分地盘

    /orders订单们

    /orders/4242 号订单

    /users用户们

  2. 查:拿一份数据,不改变任何东西

    建:新增一条数据

    删:移除一条数据

  3. /orders/42

    路径点名:第 42 号订单

  4. get /orders/42

    200返回 42 号订单详情查,是这道菜的本分
    204删掉了,没有内容需要返回204 的意思是「办妥了,没啥可说的」
    405这个地址没有 POST 这道菜方法也得在约定里——不是所有地址都能「来一份」

一条具体的地址

什么时候会遇到它

  1. 拆解需求

    「加个收藏功能」,翻译过来就是新增 POST /favorites 和 DELETE /favorites/:id。

  2. 看懂报错

    404 常常是 endpoint 地址写错了,不一定是数据不存在。

  3. 对照文档

    API 文档就是 endpoint 清单:地址、方法、参数、返回。

想一想

GET /orders 和 POST /orders,是同一个 endpoint 吗?

看答案

不是。地址相同但方法不同,就是两个 endpoint:GET /orders 查订单列表,POST /orders 创建新订单——背后对接的是两段不同的处理代码。

最容易踩的坑

Endpoint 的命名就是它的说明书:用资源名词(/orders),别用动词(/getOrderList)。风格统一,AI 和队友都能猜对下一个地址长什么样。

⌘K搜索知识库

最近收录

正在载入知识索引…