Apifox(2)快速上手apifox

发布于 2022年 01月 12日 10:53

快速上手

 

使用场景

Apifox 是接口管理、开发、测试全流程集成工具,使用受众为整个研发技术团队,主要使用者为前端开发、后端开发和测试人员。

  • 前端开发

    • 接口文档管理
    • 接口数据 Mock
    • 接口调试
    • 前端代码自动生成
  • 后端开发

    • 接口文档管理
    • 接口调试
    • 接口自动化测试
    • 后端代码自动生成
  • 测试人员

    • 接口调试
    • 接口自动化测试
       

最佳实践

1.前端(或后端)在 Apifox 上定好接口文档初稿。
2.前后端 一起评审、完善接口文档,定好接口用例
3.前端 使用系统根据接口文档自动生成的 Mock 数据进入开发,无需手写 mock 规则。
4.后端 使用接口用例 调试开发中接口,只要所有接口用例调试通过,接口就开发完成了。如开发过中接口有变化,调试的时候就自动更新了文档,零成本的保障了接口维护的及时性。
5.后端 每次调试完一个功能就保存为一个接口用例
6.测试人员 直接使用接口用例测试接口。
7.所有接口开发完成后,测试人员(也可以是后端)使用集合测试功能进行多接口集成测试,完整测试整个接口调用流程。
8.前后端 都开发完,前端从Mock 数据切换到正式数据,联调通常都会非常顺利,因为前后端双方都完全遵守了接口定义的规范。
 

基本概念

接口设计:定义接口规范(如接口路径、参数、返回值、数据结构等),也就是编写接口文档
接口运行:输入特定的接口参数,然后运行,主要用来调试接口。接口运行完之后点击保存为用例按钮,即可生成接口用例,后续可直接运行接口用例,无需再输入参数,非常方便。
接口用例:通常一个接口会有多种情况用例,比如参数正确用例、参数错误用例、数据为空用例、不同数据状态用例等等。运行接口用例时会自动校验数据正确性,用接口用例来调试接口非常高效。
数据模型:可复用的数据结构,定义接口返回数据结构请求参数数据结构(仅 JSON 和 XML 模式)时可直接引用。
集合测试:多接口集成测试,主要有功能测试性能测试对比测试
快捷调试:类似 Postman 的接口调试方式,主要用途为临时调试一些无需文档化的接口,无需提前定义接口即可快速调试。
代码生成:根据接口及数据数据模型定义,系统自动生成接口请求代码前端业务代码后端业务代码
 

与postman设计的区别

和 Postman 不一样,Apifox 是区分接口设计和接口运行两个概念的。
接口设计:即 新建接口 界面或接口详情里的 编辑 界面,用途是 定义接口文档规范,而不是 运行 接口,所以该界面是只能定义接口基本信息、参数名及参数说明等,而不能设置参数值参数值前置脚本/后置脚本 等信息请在接口运行界面或接口用例界面填写。
接口运行:即接口详情里的 运行 界面,用途是 临时调试接口运行完后,需要点击保存为用例,才能将填写的 参数值前置脚本/后置脚本 等信息保存下来;否则关闭 tab 后,这些信息将会丢失。
 

界面概览

接口设计界面

接口运行界面


__EOF__

  • 本文作者: Silent丿丶黑羽
  • 本文链接: https://www.cnblogs.com/jiakecong/p/15671285.html
  • 关于博主: 评论和私信会在第一时间回复。或者直接私信我。
  • 版权声明: 本博客所有文章除特别声明外,均采用 BY-NC-SA 许可协议。转载请注明出处!
  • 声援博主: 如果您觉得文章对您有帮助,可以点击文章右下角推荐一下。
  • 推荐文章