· 技术笔记 · 9 次阅读

RESTful API设计规范

RESTful API设计规范

良好的API设计是后端开发的重要技能。本文总结RESTful API的设计规范。

资源命名

  • 使用名词而非动词
  • 使用复数形式
  • 使用小写字母和连字符

HTTP方法

  • GET: 获取资源
  • POST: 创建资源
  • PUT: 更新资源
  • DELETE: 删除资源

状态码

  • 200: 成功
  • 201: 创建成功
  • 400: 请求错误
  • 404: 资源不存在
  • 500: 服务器错误

遵循这些规范可以让你的API更加清晰易懂。