Skip to main content

resultful风格接口

背景

在使用resultful风格接口时,我们需要在接口中定义successerror两个字段,分别表示接口是否成功,以及接口的错误信息。

resultful 请求方式

  • GET:查询
  • POST:新增
  • PUT:修改
  • DELETE:删除
  • PATCH:部分修改

Code码规范

  • 304 Not Modified 协商缓存
  • 400 Bad Request 客户端请求错误
  • 401 Unauthorized 未授权
  • 403 Forbidden 禁止访问
  • 404 Not Found 未找到
  • 405 Method Not Allowed 请求方法不被允许
  • 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求
  • 408 Request Timeout 请求超时
  • 409 Conflict 冲突
  • 410 Gone 资源已被删除
  • 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息
  • 412 Precondition Failed 客户端请求信息的先决条件错误
  • 413 Payload Too Large 客户端请求的实体数据大小超过了服务器的处理能力
  • 500 Internal Server Error 服务器内部错误
  • 501 Not Implemented 服务器不支持请求的功能
  • 502 Bad Gateway 作为网关或者代理工作的服务器尝试执行请求时,从上游服务器接收到无效的响应
  • 503 Service Unavailable 服务器当前无法处理客户端的请求,在一段时间之后可能恢复正常