04. 接口文档解析

• 目标

  • 掌握接口文档包含的内容

  • 能够进行 IHRM 系统接口文档解析

1. 接口解析

• 为什么要进行接口解析？

  • 熟悉接口的相关信息，为设计接口用例准备

• 接口解析要关注的核心要素？

  • 请求报文：请求方法/请求路径/请求数据
  • 响应报文：响应状态码/响应数据

2. 接口文档

• 接口文档
  • 又称为API文档，是由后端开发编写，用来描述接口信息的文档。

image-20230222190915105

1. 为什么要写接口文档？

• 协同：团队人员工作协同配合
• 约束：项目更新修改同步维护

2. 接口文档内容

• 基本信息
  • 接口名称、接口描述
• 请求参数
  • 请求方法
  • 请求路径
  • 请求头
  • 请求数据：字段、说明、类型、备注、是否必填
• 返回参数
  • 响应状态码
  • 响应数据：字段、说明、类型、备注、是否必填
  • data结构类型

image-20230222191053387

3. 接口文档解析内容

• 请求数据
  • URL
  • 请求方法
  • 请求头
  • 请求参数类型
  • 请求参数
• 响应数据
  • 响应状态码
  • 响应数据

4. 案例

• 人力资源管理系统接口文档解析

需求：解析ihrm系统API文档中部分接口信息
    1. 登录
    2. 添加员工
    3. 查询员工
    4. 修改员工
    5. 删除员工
    6. 城市列表
    7. 用户资料
    8. ...

• 接口文档解析模板 接口规范文档

• 实际工作中解析文档可以忽略，因为可以直接从开发提供的接口文档中获取，直接再工具或代码中使用即可

image-20230228191832224