RESTful 接口设计约定
资源命名、状态码与分页参数约定
REFERENCE · 12 ROWS
| 场景 | 约定 | 示例 |
|---|---|---|
| 资源集合 | 复数名词 | GET /api/tools |
| 单个资源 | 集合/id | GET /api/tools/123 |
| 创建 | POST 集合 | POST /api/tools |
| 全量更新 | PUT 单资源 | PUT /api/tools/123 |
| 局部更新 | PATCH 单资源 | PATCH /api/tools/123 |
| 删除 | DELETE 单资源 | DELETE /api/tools/123 |
| 分页 | page/pageSize | GET /api/tools?page=2&pageSize=20 |
| 排序 | sort=field:desc | GET /api/tools?sort=createdAt:desc |
| 过滤 | 字段名=值 | GET /api/tools?cat=dev |
| 搜索 | q=关键词 | GET /api/tools?q=json |
| 错误结构 | code/message/data | 统一响应体 |
| 时间格式 | ISO 8601 | 2026-11-16T03:00:00Z |
HOW TO USE
怎么用RESTful 接口设计约定
- 打开RESTful 接口设计约定,表格已按主题整理好。
- 在右上角输入关键词可即时筛选,不用上下翻找。
- 需要写文档时点「复制为 Markdown」,直接粘到笔记里。
RESTful 接口设计约定是什么
资源命名、状态码与分页参数约定。RESTful 接口设计约定按表格整理 12 条常用对照,打开即可查,无需翻文档。
它属于「参考速查」下的「规范标准」分类。RFC、HTTP、语义化版本等规范摘要。 同类工具还包含 语义化版本与依赖符号、开源许可证对照表、Git 提交信息规范 等,可以在分类页一次看全。
适用场景
- 处理与「RESTful」相关的任务时可以直接用。
- 处理与「API设计」相关的任务时可以直接用。
- 处理与「接口规范」相关的任务时可以直接用。
- 处理与「分页」相关的任务时可以直接用。
表格说明
本表共 12 行 3 列,内容按常用程度排序。 表格支持关键词筛选,复制出的 Markdown 可直接用于文档、Wiki 或技术博客。
隐私说明
本工具在浏览器内运行,输入内容不会发送到服务器,也不会被记录。 关闭或刷新页面后,输入即被清空。