REST API 设计速查
REST API 设计规范：HTTP 动词、URI 设计、状态码、查询参数、错误格式。
🌐 REST API Design Quick Reference
📐 工作原理与说明
RESTful API 设计要点速查。
- 资源：用名词复数表示资源集合，用 HTTP 方法表达动作，而非在 URL 中写动词。
- 状态码：200 成功、201 创建、204 无内容、400 参数错误、401 未认证、403 无权限、404 不存在、409 冲突、500 服务端错误。
- 查询：分页、过滤与排序通过查询参数传递，如
?page=1&size=20&sort=-createdAt。 - 原则：接口无状态，每次请求携带完整上下文；版本化可用 URL 前缀或请求头。
Browse a REST API cheat sheet in your browser — methods, status codes and best practices.
📚 深度解析：REST API 设计速查
💡 常见使用场景
- 资源命名/状态码/版本规范。
- 评审接口设计时对照规范：确认资源名用复数、状态码语义正确、分页与错误格式统一，减少后续返工。
命名
用复数名词 `/users/{id}`，GET 查、POST 建、PATCH 改。
❓ 常见问题（FAQ）
- 409 与 400 区别？
- 400 请求格式错，409 冲突（如重复创建）。
- 版本该放在 URL 还是请求头？
- 两种都有实践：URL 路径（/v1/users）最直观、便于缓存与调试，是最常见选择；请求头（Accept: application/vnd.api+json;version=1）保持 URL 干净，但不易在浏览器里直接测试。选择后应保持一致，并明确废弃策略——提前公告、并行运行一段时间再下线。
⚠️ 使用说明与注意事项
- 本工具纯前端运行，数据不会上传到服务器
- 建议在主流浏览器（Chrome/Safari/Firefox/Edge）中使用
- 计算结果仅供参考，请以实际应用场景为准
已复制
▼
工具简介
REST API 设计速查。专为开发者打造的在线工具，纯前端运行，代码不离开浏览器。