RESTful风格设计及测试

1、什么是Restful

• 本质：一种软件架构风格。
• 核心：面向资源
• 解决的问题：
  • 降低开发的复杂度
  • 提高系统的可伸缩性
• 设计概念和准则：
  • 网络上的所有事物都可以被抽象为资源。
  • 每一个资源都有唯一的资源标识，对资源的操作不会改变这些标识。
  • 所有的额操作都是无状态的。

2、SOAP和REST的区别

什么是SOAP WebService：

• WebService是一种跨编程语言和跨操作系统平台的远程调用技术。
• WebService通过HTTP协议发送请求和接收结果是采用XML格式封装，并增加一些特定的HTTP消息头，这些特定的HTTP消息头和XML消息格式就是SOAP协议

区别：

• 效率和易用性：
  • SOAP由于各种需求不断扩充其本身协议的内容，导致在SOAP处理方面的性能有所下降。同时在易用性方面以及学习成本上也有所增加
  • RESTful由于其面向资源接口设计以及操作抽象简化了开发者的不良设计，同时也最大的利益了Http最初的应用协议设计理念。
• 安全性：
  • RESTful对于资源型服务接口来说很合适，同时特别适合对于效率要求很高，但是对于安全要求不高的场景。
  • SOAP的成熟性可以给需要提供给多开发语言的，对于安全性要求较高的接口设计带来便利，所以我觉得纯粹说什么设计模式将占据主导地位没有什么意义，关键还是看应用场景。

3、如何设计RESTFul风格API

• 资源路径（URI）

  • 在RESTful架构中，每个网址代表一种资源，所以网址中不能有动词，只能有名词。一般来说API中的名词应该使用复数。

  • 举例

    一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。

    • https://api.example.com/v1/zoos //动物园资源
    • https://api.example.com/v1/animals //动物资源
    • https://api.example.com/v1/employees // 雇员资源

• HTTP动词

  • 对于资源的具体操作类型，由HTTP动词表示。

    常用的HTTP动词有下面五个（括号里是对应的SQL命令）。

    • GET（SELECT）：从服务器取出资源（一项或多项）。
    • POST（CREATE）：在服务器新建一个资源。
    • PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
    • PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
    • DELETE（DELETE）：从服务器删除资源。

    还有两个不常用的HTTP动词。

    • HEAD：获取资源的元数据。
    • OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

    举例

    • GET /zoos：列出所有动物园
    • POST /zoos：新建一个动物园
    • GET /zoos/ID：获取某个指定动物园的信息
    • PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
    • PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
    • DELETE /zoos/ID：删除某个动物园
    • GET /zoos/ID/animals：列出某个指定动物园的所有动物
    • DELETE /zoos/ID/animals/ID：

• 过滤信息

  • 如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。

    下面是一些常见的参数。

    • ?limit=10：指定返回记录的数量
    • ?offset=10：指定返回记录的开始位置。
    • ?page=2&per_page=100：指定第几页，以及每页的记录数。
    • ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
    • ?animal_type_id=1：指定筛选条件

    参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。

• 状态码

  • 服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

    • 200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
    • 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
    • 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
    • 204 NO CONTENT - [DELETE]：用户删除数据成功。
    • 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
    • 401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
    • 403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
    • 404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
    • 406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
    • 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
    • 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
    • 500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

• 错误处理

  • 如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

    {
        error: "Invalid API key"
    }
    

• 返回结果

  • 针对不同操作，服务器向用户返回的结果应该符合以下规范。

    • GET /collection：返回资源对象的列表（数组）
    • GET /collection/resource：返回单个资源对象
    • POST /collection：返回新生成的资源对象
    • PUT /collection/resource：返回完整的资源对象
    • PATCH /collection/resource：返回完整的资源对象
    • DELETE /collection/resource：返回一个空文档

4、REST风格的接口测试流程

1. 了解接口格式
2. 编写测试用例
3. 测试用例评审
4. 开始测试
5. 完成测试报告
6. 结束

5、如何编写功能测试计划

需求描述

• GET:
  • http://localhost:8080/MyWebsite/user/
  • Header: Content-Type = application/json
  • Body: 空
  • Response: 返回所有User对象
  • Status code: 200
• GET:
  • http://localhost:8080/MyWebsite/user/{id}
  • Header: Content-Type = application/json
  • Body: 空
  • Response: 返回指定id的User对象
  • Status code: 200
• POST:
  • http://localhost:8080/MyWebsite/user/
  • Header: Content-Type = application/json
  • Body: name(String类型,不为空不可重复),age(int类型,在0和100之间),salary(double类型)
  • Response: 新加User对象 S
  • tatus code: 201
• PUT:
  • http://localhost:8080/MyWebsite/user/{id}
  • Header: Content-Type = application/json
  • Body: name(String类型,不为空不可重复),age(int类型,在0和100之间),salary(double类型)
  • Response: 修改User对象
  • Status code: 201
• DELETE:
  • http://localhost:8080/MyWebsite/user/{id}
  • Header: Content-Type = application/json
  • Body: 空
  • Response: 删除id的User对象 S
  • tatus code: 204
• DELETE:
  • http://localhost:8080/MyWebsite/user/
  • Header: Content-Type = application/json
  • Body: 空
  • Response: 删除所有User对象
  • Status code: 204
• 错误返回:
  • Code: 4 Message: 找不到指定id对象
  • Code: 5 Message: 对象已经存在(对象已经冲突了)
  • Code: 6 Message: 参数不匹配

测试计划

• 业务流程-GET：
  • 正向用例：返回所有的对象和返回某一个对象
  • 负向用例：一个不存在的id，URL输入不正确
• 业务流程-POST：
  • 正向用例：
    • 输入正确参数新加一个对象（特殊符号，中文等）
  • 负向用例：
    • 参数name为空/重复
    • 参数age为0/-1/100/101/字符串/null/空
    • 参数salary为整数/带小数/负数/null/空
• 业务流程-put：
  • 正向用例：
    • 输入正确参数修改一个对象（特殊符号，中文等）
  • 负向用例：
    • 参数id为空/无效值
    • 参数name为空/重复
    • 参数age为0/-1/100/101/字符串/null/空
    • 参数salary为整数/带小数/负数/null/空
• 业务流程-DELETE：
  • 正向用例：删除所有的对象和删除某一个对象
  • 负向用例：一个不存在的id，URL输入不正确

6、如何使用Postman验证测试用例

GET请求：

使用Tests验证

负向用例

POST请求：

执行结果

负向用例：

名字相同：

执行结果

名字为空：

执行结果：

PUT请求：

DELETE请求：