RESTful API 设计规范

RESTful API 设计

好的 API 设计能让前后端协作更加顺畅。

URL 命名

使用名词复数形式,避免动词:

GET /api/articles
POST /api/articles
GET /api/articles/1
PUT /api/articles/1
DELETE /api/articles/1

状态码

  • 200 - 成功
  • 201 - 创建成功
  • 400 - 请求错误
  • 401 - 未认证
  • 403 - 无权限
  • 404 - 未找到
  • 500 - 服务器错误