rest接⼝怎么传list_如何设计⼀个优雅的RESTFUL的接⼝
⼀、引⼊
设计接⼝是我们开发⼈员的⽇常操作。当我们把接⼝交给前端⼈员时,是否有种拔剑出鞘的错觉。毕竟交付接⼝,我们的开发⼯作就阶段性完成了。不过,如果我们没有⼀个接⼝设计规范的时候,结果会怎样呢?我们来张图感受⼀下。
⼆、REST
2000年,⼀个年轻⼩伙⼦(Roy Thomas Fielding)在他的博⼠论⽂提出了 REST。REST 是⼀种万维⽹软件架构风格。为什么说是风格不是标准呢?个⼈理解可能说标准就有点过分了。⼩伙⼦做不到。随后这种风格被推⼴开来,漂洋过海,被⼤众熟知。在 REST 的基础上,产⽣了 RESTFUL 。什么是 RESTFUL?简单的说,符合 REST 风格的接⼝就是 RESTFUL。
三、RESTFUL
接⼝各种各样。正如⼀千个⼈眼⾥有⼀千个鲁迅。RESTFUL 接⼝究竟长什么样⼦呢?
3.1 HTTP 的⽅法
HTTP ⾥⾯有⼏个基本的⽅法。我们利⽤这些约定⼀些规范。
从表中,如果我们可以清楚看到当我们的接⼝是关于获取数据,那么我们使⽤ GET ⽅法。
如果我们可以清楚看到当我们的接⼝是关于插⼊数据,那么我们使⽤ POST ⽅法。
如果我们可以清楚看到当我们的接⼝是关于更新数据,那么我们使⽤ PUT ⽅法。
如果我们可以清楚看到当我们的接⼝是关于删除数据,那么我们使⽤ DELECT ⽅法。
3.2 名词
在上⾯我们已经知道接⼝在什么时候需要什么⽅法,那么我们现在来进⼊到设计接⼝的第⼆步。
我们看看线上⽹站的接⼝是怎么样的。大众怎么样
图中我们可以看到有个 v1 ,他代表的是版本号,所以我们在设计接⼝的时候可以在将版本号写上,⽤ v1、v2、v3 等表⽰。我们发现他的接⼝都是名词。所以我们知道 RESTFUL 接⼝使⽤的是名词。⽐如
我们设计⼀个获取数据的接⼝,我们可这样设计/
上⾯接⼝是获取所有数据。
当我们需要列表中的⼀条数据,我们可以这样设计
/
上⾯接⼝表⽰获取是列表的1号数据,我们可以获取2号、3号数据等等,只要改变数字即可。
3.3 组合
结合上⾯两步,我们就可以设计出增删改查的 restful 接⼝了。
3.4 应⽤
以下是源码的demo
import
四、某同城交友⽹站
暗号:荆轲刺秦王
发布评论