一、什么是RESTful
1、起源
REST这个词起源于2000年Roy Thomas Fielding在他的博士论文中提出。
他是HTTP协议(1.0版和1.1版)的主要设计者、Apache服务器软件的作者之一、Apache基金会的第一任主席。
而他写这篇论文的目的是:在符合架构原理的前提下,理解和评估以网络为基础的应用软件的架构设计,得到 一个功能强、性能好、适宜通信的架构。
2、名称由来
REST,即Representational State Transfer的缩写,翻译过来就是"表现层状态转化"
3、特点
REST最大的几个特点为:资源、统一接口、URI、无状态。
4、资源
REST的名称"表现层状态转化"中,省略了主语。"表现层"其实指的是"资源"(Resources)的"表现层"。
所谓"资源",就是网络上的一个实体,或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务,总之就是一个具体的实在。你可以用一个URI(统一资源定位符)指向它,每种资源对应一个特定的URI。要获取这个资源,访问它的URI就可以,因此URI就成了每一个资源的地址或独一无二的识别符。
所谓"上网",就是与互联网上一系列的"资源"互动,调用它的URI。
5、RESTful 架构
REST对URL的处理还是对Payload的编码,REST都倾向于用更加简单轻量的方法设计和实现。值得注意的是REST并没有一个明确的标准,而更像是一种设计的风格。
REST 指的是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是 RESTful。
RESTful架构是对MVC架构改进后所形成的一种架构,通过使用事先定义好的接口与不同的服务联系起来。在RESTful架构中,浏览器使用POST,DELETE,PUT和GET四种请求方式分别对指定的URL资源进行增删改查操作。因此,RESTful是通过URL实现对资源的管理及访问,具有扩展性强、结构清晰的特点。
RESTful架构将服务器分成前端服务器和后端服务器两部分,前端服务器为用户提供无模型的视图;后端服务器为前端服务器提供接口。浏览器向前端服务器请求视图,通过视图中包含的AJAX函数发起接口请求获取模型。
二、REST和SOAP的区别
首先我们要知道三种主流的Web服务实现方案:
REST:表象化状态转变 (软件架构风格)
SOAP:简单对象访问协议
XML-RPC:远程过程调用协议(已慢慢的被SOAP所取代)
1、效率和易用性
REST由于其面向资源接口设计以及操作抽象简化了开发者的不良设计,同时也最大限度的利用了HTTP最初的应用协议设计理念。
SOAP由于各种需求不断扩充其本身协议的内容,导致在SOAP处理方面的性能有所下降。同时在易用性方面以及学习成本上也有所增加。
2、安全性
REST对于资源型服务来说很合适,同时特别适合对于效率要求很高,但是对于安全性不高的场景。
SOAP的成熟性可以给需要提供给多开发语音的,对于安全性要求较高的接口设计带来便利。
总结:
简单数据操作,无事务处理,开发和调用简单使用REST架构风格较好。
若有严格的规范和标准定义要求,且前期需要指导多个业务系统集成和开发的时,因SOAP风格有清晰的规范标准定义,SOAP更适合。
三、RESTful实战
- GET(SELECT):从服务器取出资源(一项或多项)。
- POST(CREATE):在服务器新建一个资源。
- PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
- PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。
- DELETE(DELETE):从服务器删除资源。
例子:
- GET /zoos:列出所有动物园
- POST /zoos:新建一个动物园
- GET /zoos/id:获取某个指定动物园的信息
- PUT /zoos/id:更新某个指定动物园的信息(提供该动物园的全部信息)
- PATCH /zoos/id:更新某个指定动物园的信息(提供该动物园的部分信息)
- DELETE /zoos/id:删除某个动物园
- GET /zoos/animals/id:列出某个指定动物园的所有动物
- DELETE /zoos/animals/id:删除某个指定动物园的指定动物
四、RESTful接口测试流程
1.获取url
如上图,假若测试用户列表这个接口,则其url就是/users/list
2.找到所需的传参,记录所需的测试用例(测试用例下一部分讲)
@Data
public class UserSearch extends Page {
@ApiModelProperty("昵称")
private String nickname;
@Pattern(regexp = "[\\d]{10}||^\\s$", message = "网号不正确或长度不对!")
@ApiModelProperty("网号")
private String userNumber;
@Pattern(regexp = "^1[3-9]\\d{9}|9[2-8]\\d{9}$|(\\+|00)(297|93|244|1264|358|355|376|971|54|374|1684|1268|61|43|994|257|32|229|226|880|359|973|1242|387|590|375|501|1441|591|55|1246|673|975|267|236|1|61|41|56|86|225|237|243|242|682|57|269|238|506|53|5999|61|1345|357|420|49|253|1767|45|1809|1829|1849|213|593|20|291|212|34|372|251|358|679|500|33|298|691|241|44|995|44|233|350|224|590|220|245|240|30|1473|299|502|594|1671|592|852|504|385|509|36|62|44|91|246|353|98|964|354|972|39|1876|44|962|81|76|77|254|996|855|686|1869|82|383|965|856|961|231|218|1758|423|94|266|370|352|371|853|590|212|377|373|261|960|52|692|389|223|356|95|382|976|1670|258|222|1664|596|230|265|60|262|264|687|227|672|234|505|683|31|47|977|674|64|968|92|507|64|51|63|680|675|48|1787|1939|850|351|595|970|689|974|262|40|7|250|966|249|221|65|500|4779|677|232|503|378|252|508|381|211|239|597|421|386|46|268|1721|248|963|1649|235|228|66|992|690|993|670|676|1868|216|90|688|886|255|256|380|598|1|998|3906698|379|1784|58|1284|1340|84|678|681|685|967|27|260|263)(9[976]\\d|8[987530]\\d|6[987]\\d|5[90]\\d|42\\d|3[875]\\d|2[98654321]\\d|9[8543210]|8[6421]|6[6543210]|5[87654321]|4[987654310]|3[9643210]|2[70]|7|1)\\d{4,20}$", message = "手机号码不正确!")
@ApiModelProperty("手机号")
private String mobile;
@ApiModelProperty("授权方id")
private String sourceId;
}
由上图可见有4个可传可不传的参数,其中两个注释了正则表达式,代表若需要传这两个参数就必须符合其正则
3.获取端口号
两种方式:
-
在配置文件.properties或.yml文件中找到端口号
- 运行项目:
4.发送请求
本地IP地址除了localhost也可以用127.0.0.1
可以发现此请求并没有传任何参数
传参的示例:
五、编写功能测试计划
认识接口状态码:
常见的几个状态码:
- 200 - OK 一切正常,对GET和POST请求的应答文档跟在后面。
- 401 - 授权失败
- 404 - Not Found 无法找到指定位置的资源。
- 500 -一般是接口的实现代码有问题
更多状态码可参考https://blog.csdn.net/qq_40028324/article/details/80896768
编写测试计划
编写测试用例要注意以下几点:
- 是否满足前提条件
- 是否携带默认值参数
- 业务规则、功能需求
- 参数是否必填
- 参数之间是否存在关联
- 参数数据类型限制
- 参数数据类型自身的数据范围值限制
接口测试计划模板:
六、使用Postman验证测试用例
1、官网下载postman
下完双击安装就行,无需其他操作
2、postman界面
3、请求区域
- 1.Authorization:身份验证,主要用来填写用户名密码,以及一些验签字段,postman有一个helpers可以帮助我们简化一些重复和复杂的任务。当前的一套helpers可以帮助你解决一些authentication protocols的问题。;
- 2.Headers:请求的头部信息
- 3.Body:post请求时必须要带的参数,里面放一些key-value键值对
- 4.Pre-requerst Script:可以让你在 请求之前自定义请求数据,这个运行在请求之前,语法使用JavaScript语句。
- 5.tests:tests标签功能比较强大,通常用来写测试,它是运行在请求之后。支持JavaScript语法。postman每次执行request的时候,会执行tests。测试结果会在tests的tab上面显示一个通过的数量以及对错情况。这个后面会进行详解,它也可以用来设计用例,比如要测试返回结果是否含有某一字符串
- 6.form-data:,它将表单数据处理为一条消息,以标签为单元,用分隔符分开。既可以单独上传键值对,也可以直接上传文件(当上传字段是文件时,会有Content-Type来说明文件类型,但该文件不会作为历史保存,只能在每次需要发送请求的时候,重新添加文件。);post请求里较常用的一种
- 7.x-www-form-urlencoded:对应信息头-application/x-www-from-urlencoded,会将表单内的数据转换为键值对;
- 8.raw:可以上传任意类型的文本,比如text、json、xml等,所有填写的text都会随着请求发送;
- 9.binary:对应信息头-Content-Type:application/octet-stream,只能上传二进制文件,且没有键值对,一次只能上传一个文件, 也不能保存历史,每次选择文件,提交;
当出现接口出现@RequestBody注释时,测试时用Body传参,如下:
@ApiOperation("根据条件查找")
public IPage<UserVO> findUser(@Valid @RequestBody UserSearch userSearch){
return iUserService.findUser(userSearch);
}
4、使用测试用例
每个接口都可以保存起来方便以后操作: