03. 接口规范和测试流程

• 本节内容

  • 接口规范

  • 接口测试流程

• 目标

  • 能够说出 Restful 接口特点

  • 能够说出接口测试流程

1. 接口规范

1. 传统接口风格

• 举例：对用户进行操作的相关接口，包括增删改查

操作	请求方式	URL	成功状态码
查询某个用户	GET/POST	http://127.0.0.1:8080/myweb/user/getUser?id=1 http://127.0.0.1:8080/myweb/user/getById?id=1 http://127.0.0.1:8080/myweb/getUserById?id=1	200
查询所有用户	GET/POST	http://127.0.0.1:8080/myweb/user/getUserList http://127.0.0.1:8080/myweb/user/getUsers	200
添加用户	POST	http://127.0.0.1:8080/myweb/user/addUser http://127.0.0.1:8080/myweb/user/saveUser	200
修改用户	POST	http://127.0.0.1:8080/myweb/user/updateUser http://127.0.0.1:8080/myweb/user/editUser	200
删除用户	GET/POST	http://127.0.0.1:8080/myweb/user/deleteUser?id=1 http://127.0.0.1:8080/myweb/user/delUser?id=1	200

接口统一采用 get/post 实现所有操作
URL 与资源不是一一对应的，在url中看不出是哪种操作
状态码统一返回200

2. RESTful风格

• RESTful 是一种网络应用程序的设计风格和开发方式，并不是必须要遵守的标准，只是提供了一组设计原则和约束条件

操作	请求方式	URL	成功状态码
查询某个用户	GET	http://127.0.0.1:8080/myweb/user/1	200
查询所有用户	GET	http://127.0.0.1:8080/myweb/user	200
添加用户	POST	http://127.0.0.1:8080/myweb/user	201
修改用户	PUT	http://127.0.0.1:8080/myweb/user/1	201
删除用户	DELETE	http://127.0.0.1:8080/myweb/user/1	204

• 好处：提供了一套统一遵守的规范，方便团队配合，提高工作效率

• RESTful接口API设计规范

  • 特点： 面向资源

  • 请求 API 的 URL 用来定位资源（名词表示）

    • 资源集合
      • /user // 所有用户
    • 单个资源
      • /user/1001 // id为1001的用户

  • 通过标准HTTP方法对资源 CRUD

    • GET /user // 获取所有用户
    • GET /user/1001 // 获取 id为1001的用户
    • POST /user // 新增用户
    • PUT /user // 修改用户
    • DELETE /user/1001 // 删除id为1001的用户

  • 利用HTTP状态码返回状态信息

    接口使用的方法与http协议的请求方法一一对应： get：查； post:增； put:改; delete:删
    URL与资源一一对应，不能从URL中看出是何种操作，需要结合请求方法识别是何种操作
    状态码使用较为全面

3. 传统风格和RESTful对比

接口规范	请求方式	URL	状态码
传统风格	使用get/post完成增删改查	url定义资源和操作混合	均为200
RESTful	遵循HTTP协议方法定义	url仅定义一个资源，不包含对资源的操作	遵循HTTP协议状态码定义

2. 接口测试流程

1. 需求分析 (产品经理的需求文档)
2. 接口文档解析 (开发编写的接口API文档)
3. 设计测试用例 (编写Excel表格形式的用例)
4. 脚本开发 (代码或工具)
5. 执行及缺陷跟踪 (用例执行、跟踪缺陷)
6. 生成测试报告 (生成接口测试报告)
7. 接口自动化持续集成(可选)