简体中文
English 简体中文 繁體中文
Methodox 首页

REST API

1. 为什么你应该关心

REST(REpresentational State Transfer,表述性状态转移)是 Web 服务事实上的标准风格:你会遇到的公共 API 中大约每 10 个就有 8 个遵循它,因此掌握其基础知识,几乎就能与任何现代后端通信。(Integrate.io)

2. 60 秒了解 REST

REST API 通过普通的 HTTP 公开资源(名词,例如 /users/42)。客户端使用标准动词对这些资源进行操作:

动词 典型用途 幂等?
GET 读取 ✔︎
POST 创建 / 其他操作 ✖︎
PUT 替换 ✔︎
PATCH 部分更新 ✖︎
DELETE 删除 ✔︎

RESTful 服务器还必须遵循六项架构约束(统一接口、客户端-服务器、无状态、可缓存、分层系统,以及可选的按需代码)。(restfulapi.net,Integrate.io)

3. 常见响应码

  • 200 OK / 201 Created——成功
  • 400 Bad Request——客户端错误(JSON 格式错误、缺少字段)
  • 401/403 Unauthorized / Forbidden——认证/授权问题
  • 404 Not Found——URI 错误或记录不存在
  • 500+ 服务器错误——bug、服务中断等。(Postman Blog)

4. 一个小小的“Hello World”示例

GET https://api.example.com/items/123
Accept: application/json

典型的 JSON 响应:

{
  "id": 123,
  "name": "Widget",
  "price": 9.99
}

5. 在 Divooka 中试用 REST

在 Divooka 中,你可以用节点图来构建请求,而不必填写冗长的表单:

  1. Send (HTTP) Request 节点——设置为 GET,URL 为 {{baseUrl}}/items/{{itemId}}。
  2. Headers——放置一个 Custom Header 节点,用于 Accept: application/json 这样的键值对。
  3. (可选)Auth node——选择 Basic、Bearer 或 OAuth 2.0。
  4. 使用 Preview JSON 节点解析 JSON 负载——它会美化打印响应体并进行类型检查。

一切都是可视化且可复用的:把同一个响应连接到后续逻辑中(保存到数据库、更新 UI、触发另一个请求),无需编写胶水代码。

使用截图

你可以在 Web API 测试页面查看更多实际示例。

环境变量

在 Environments 中定义一次 baseUrl、apiKey 或 authToken,然后就可以在任何地方通过 Get Environment Variable 节点引用它们。使用 Switch 节点在不同环境(dev/staging/prod)之间切换。

保存与共享

把相关的请求保存并归组到图中,作为文档保存,以便轻松复用和共享。

6. 最佳实践清单

设计你自己的 REST API 时:

  • URI 以名词为基础(使用 /orders/17,而不是 /getOrder)。
  • 使用正确的动词(不要用 GET /deleteUser)。
  • 提供分页和过滤(?page=2&limit=50)。
  • 在路径或请求头中标明版本(/v1/),绝不破坏现有客户端。
  • 使用 HTTPS、身份验证和合理的速率限制来保障安全。
  • 使用 OpenAPI 编写文档;Divooka 可以导入该规范并自动生成节点脚手架。(idratherbewriting.com)

7. 延伸阅读

  • 还想了解更多?请查看我们对 HTTP、方法与 Web API 这一主题的深入讨论。
  • Divooka 中的使用文档。
  • Roy Fielding 的 REST 博士论文(原始出处)
  • RFC 9110——HTTP 语义
  • Postman 的“REST API examples”博客文章,介绍真实场景中的模式(Postman Blog)
  • Divooka Wiki → App Development > API Testing(深入介绍每个节点和功能)

掌握了这些要点,你就可以自信地探索任何 REST 端点,并将其接入你的 Divooka 流程,以满足你的应用需求。