RESTful接口规范

HTTP动词

资源的具体操作类型,由HTTP动词表示。

常见的五个HTTP动词(括号对应SQL命令)

  • GET (读取): 从服务器取出资源(一项或者多项)。
  • POST(创建): 在服务器新建一个资源。
  • PUT(完整更新): 在服务器更新一个资源(客户端提供改变后的完整资源)。
  • PATCH(部分更新): 在服务器更新一个资源(客户端提供改变的属性)。
  • DELETE(删除): 从服务器删除资源。

HTTP状态码

客户端每一次请求,服务区都必须给出回应。回应包括HTTP状态码和数据两部分。

HTTP状态码就是一个三位数,分成五个类别。

  • 1XX:相关信息
  • 2XX:操作成功
  • 3XX:重定向
  • 4XX:客户端错误
  • 5XX:服务器错误

常见状态码:(方括号中对应该状态码的HTTP动词)

  • 200 OK - [GET]:服务器成功返回用户请求的数据。
  • 201 CREATED - [POST、PUT、PATCH]:用户新建或修改数据成功。
  • 204 NO CONTENT - [DELETE]:用户删除数据成功。
  • 401 Unauthorized - [ * ]:表示用户没有权限(令牌、用户名、密码错误)。
  • 403 Forbidden - [ * ]:表示用户得到授权(与401错误相对),但是访问是被禁止的,比如管理员权限操作。
  • 404 NOT FOUND - [ * ]:用户发出的请求真的的是不存在的记录,服务器没有进行操作,也就是常见的404页面。
  • 500 INTERNAL SERVER ERROR - [ * ]:服务器内部错误.
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 总方针 构建易于理解和使用的RESTful接口。 接口应该是直观的,调用者可以通过接口来获得系统或应用程序中所有业...
    nikytwo阅读 6,192评论 0 3
  • 把api放在专属域名下,要带版本号 api的url中应该只有名词,和数据库的表或文档资源相对应;对资源(colle...
    YouKnowznM阅读 3,030评论 0 0
  • REST 是面向资源的,这个概念非常重要,而资源是通过 URI 进行暴露。 REST API 是基于 HTTP的,...
    RolexOO阅读 12,615评论 1 1
  • 概念 本质:一种软件架构风格 核心:面向资源设计的API 解决问题: 降低开发的复杂性 提高系统的可伸缩性 ...
    114105lijia阅读 6,107评论 0 0
  • 版本(Versioning) 所有的API必须保持向后兼容,必须在引入新版本API的同时确保旧版本API仍...
    皮皮杂谈阅读 6,421评论 0 10