欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

RESTful api风格介绍

程序员文章站 2022-07-10 22:12:13
RESTful 接口是目前来说比较流行的一种接口,平常在开发中会非常常见。 有过和后端人员对接接口的小伙伴都应该知道,我们所做的大多数操作都是对数据库的四格操作 “增删改查” 对应到我们的接口操作分别是: 注意,这里是我们约定,并非这些动作只能干这件事情。从表层来说,除get外的其他方法,没有什么区 ......

restful 接口是目前来说比较流行的一种接口,平常在开发中会非常常见。

有过和后端人员对接接口的小伙伴都应该知道,我们所做的大多数操作都是对数据库的四格操作 “增删改查” 对应到我们的接口操作分别是:

  1. post 插入新数据
  2. delete 删除数据
  3. put 修改数据
  4. get 查询数据

注意,这里是我们约定,并非这些动作只能干这件事情。从表层来说,除get外的其他方法,没有什么区别,都是一样的。从深层来说包括 get 在内的所有方法都是一模一样的,没有任何区别。但是,我们约定,每种动作对应不同的操作,这样方便我们统一规范我们的所有操作。

假设,我们的接口是 /api/v1/love 这样的接口,采用 restful 接口风格对应操作是如下的:


get 操作 /api/v1/love

获取 /api/v1/love 的分页列表数据,得到的主体,将是一个数组,我们可以用数据来遍历循环列表

post 操作 /api/v1/love

我们会往 /api/v1/love 插入一条新的数据,我们插入的数据,将是josn利用对象传输的。

get 操作 /api/v1/love/1

我们获取到一个 id 为 1 的的数据,数据一般为一个对象,里面包含了 1 的各项字段信息。

put 操作 /api/v1/love/1

我们向接口提交了一个新的信息,来修改 id 为 1 的这条信息

delete 操作 /api/v1/love/1

我们向接口请求,删除 id 为 1 的这一条数据


由上述例子可知,我们实现了5种操作,但只用了两个接口地址, /api/v1/love 和 /api/v1/love/1 。所以,采用这种接口风格,可以大幅的简化我们的接口设计。