接口规范

  • GET 
  • 安全且幂等 
  • 获取表示 
  • 变更时获取表示(缓存) 
  1. 200 (OK) - 表示已在响应中发出 
  2. 204 (无内容) - 资源有空表示 
  3. 301 (Moved Permanently) - 资源的URI已被更新 
  4. 303 (See Other) - 其他(如,负载均衡) 
  5. 304 (not modified)- 资源未更改(缓存) 
  6. 400 (bad request)- 指代坏请求(如,参数错误) 
  7. 404 (not found)- 资源不存在 
  8. 406 (not acceptable)- 服务端不支持所需表示 
  9. 500 (internal server error)- 通用错误响应 
  10. 503 (Service Unavailable)- 服务端当前无法处理请求 
  • POST 
  • 不安全且不幂等 
  • 使用服务端管理的(自动产生)的实例号创建资源 
  • 创建子资源
  • 如果没有被修改,则不过更新资源(乐观锁) 
  1. 200 (OK)- 如果现有资源已被更改 
  2. 201 (created)- 如果新资源被创建 
  3. 202 (accepted)- 已接受处理请求但尚未完成(异步处理) 
  4. 301 (Moved Permanently)- 资源的URI被更新 
  5. 303 (See Other)- 其他(如,负载均衡) 
  6. 400 (bad request)- 指代坏请求 
  7. 404 (not found)- 资源不存在 
  8. 406 (not acceptable)- 服务端不支持所需表示 
  9. 409 (conflict)- 通用冲突 
  10. 412 (Precondition Failed)- 前置条件失败(如执行条件更新时的冲突) 
  11. 415 (unsupported media type)- 接受到的表示不受支持 
  12. 500 (internal server error)- 通用错误响应 
  13. 503 (Service Unavailable)- 服务当前无法处理请求 
  • PUT 
  • 不安全但幂等 
  • 用客户端管理的实例号创建一个资源 
  • 通过替换的方式更新资源 
  • 如果未被修改,则更新资源(乐观锁) 
  1. 200 (OK)- 如果已存在资源被更改 
  2. 201 (created)- 如果新资源被创建 
  3. 301 (Moved Permanently)- 资源的URI已更改 
  4. 303 (See Other)- 其他(如,负载均衡) 
  5. 400 (bad request)- 指代坏请求 
  6. 404 (not found)- 资源不存在 
  7. 406 (not acceptable)- 服务端不支持所需表示 
  8. 409 (conflict)- 通用冲突 
  9. 412 (Precondition Failed)- 前置条件失败(如执行条件更新时的冲突) 
  10. 415 (unsupported media type)- 接受到的表示不受支持 
  11. 500 (internal server error)- 通用错误响应 
  12. 503 (Service Unavailable)- 服务当前无法处理请求 
  • DELETE
  • 删除资源 
  1. 200 (OK)- 资源已被删除 
  2. 301 (Moved Permanently)- 资源的URI已更改 
  3. 303 (See Other)- 其他,如负载均衡 
  4. 400 (bad request)- 指代坏请求 
  5. 404 (not found)- 资源不存在 
  6. 409 (conflict)- 通用冲突 
  7. 500 (internal server error)- 通用错误响应 
  8. 503 (Service Unavailable)- 服务端当前无法处理请求