REST(表述性状态转移)是一种软件架构风格,REST API 则是遵循该风格的接口。它把系统里的数据或功能抽象为资源,通过 HTTP 协议对外提供增删改查。简单说:用网址定位资源,用 HTTP 方法表达动作。
REST API 是当前最主流的接口风格。本文用大白话讲清资源、URI、HTTP 方法、状态码与设计原则,帮非技术同学快速建立认知,也帮开发者少踩坑。
YesApi Pro 低代码生成规范化 REST API,自带文档、鉴权与限流。
REST(表述性状态转移)是一种软件架构风格,REST API 则是遵循该风格的接口。它把系统里的数据或功能抽象为资源,通过 HTTP 协议对外提供增删改查。简单说:用网址定位资源,用 HTTP 方法表达动作。
| 方法 | 含义 | 示例 |
|---|---|---|
| GET | 查询 | GET /users/1 |
| POST | 新增 | POST /users |
| PUT | 整体更新 | PUT /users/1 |
| DELETE | 删除 | DELETE /users/1 |
2xx 成功(200/201);4xx 客户端错误(400 参数错、401 未认证、403 无权限、404 不存在);5xx 服务端错误(500)。规范使用状态码能让调用方快速判断结果。
① 用名词而非动词表示资源(/orders 而非 /getOrder);② 合理版本化(/v1/);③ 用查询参数做过滤分页;④ 返回一致的错误结构;⑤ 配合文档与鉴权。想深入可看《高质量 REST API 设计 8 技巧》。