【规范】Apifox就应该这么玩

简介: 本文作者通过对比Postman与Apifox,分享了在项目中使用Apifox进行接口文档整理的方法,旨在帮助读者提升工作效率。文章详细介绍了Apifox目录整理策略、环境管理技巧及前置/后置操作的应用,使接口管理更加有序高效。无论是在短期开发还是长期迭代项目中,这些方法都能帮助开发者更好地管理和维护接口文档。

前言

🍊缘由

好的工具就要配好的玩法

起因是最近在回顾项目时,看到了年事已高并且长时间不用的Postman,发现之前自己整理的接口文档十分混乱且没有规律。遂打开现在使用的Apifox,将本狗目前项目中使用Apifox的整理规范和使用方法分享给大家,希望能有些许帮助。


🎯主要目标

实现3大重点

1. 如何在Apifox整理目录
2. 善于使用管理环境
3. 灵活使用前置/后置操作

正文

🍊1.Apifox整理目录

整理前的Postman接口目录

整理后的Apifox接口目录

有的小伙伴可能觉得这整理前和整理后没啥区别,反正就是工具,怎么用怎么舒服。

此话对否?非常对!但只是出于短平快的开发周期来讲没有任何毛病。如果是一个长期迭代,而且流程计划很正规的产品来讲,就显得有些杂乱无章。

本狗就是一个鲜活的例子,总是觉得每次迭代规整接口费时费力,但是实际划分为每个迭代版本后如果某个版本接口有问题,翻一下接口文档即可轻松定位。不仅美观还很省时省力,自己写起来也舒心。

所以,本狗的整理目录策略按照项目大分类,然后根据不同迭代版本加入前缀,如v1.0.1-用户-登录,v1.0.1-用户-注册等


🍋2.管理环境

项目中开发中,可能会涉及到多个环境,如开发,测试,生产环境等。这就导致接口前缀会有多个不同,所以环境变量的设置尤为重要,不仅可以简化接口地址,并且能够提高接口复用性,去除冗余配置。

🌰举例:

用户登录接口:/user/login

需要组合正确的url,分别是:

采用环境变量 { {baseUrl}} 来代替访问接口前缀 :
{ {baseUrl}}/user/login

如何在环境变量里设置?

  1. 点击右上角【管理环境变量】

  2. 设置服务名,并写入前置URL,并点击【保存】

  3. 重复上述1,2操作,将不同环境的前缀路径分别录入

  4. 在新建接口时,不用写入前缀URL,只需写目标路径即可


🥝3.前置/后置操作

什么是前置/后置操作?

前置操作和后置操作都是 API 请求在发送和响应过程中执行的脚本,主要用于在发起 API 请求前和获得响应后完成验证或执行某些操作,目的是为了提高 API 调试和测试的效率,并确保接口的正确性。

大白话就是:在你执行接口前做一些事,叫做前置操作;在你执行接口后做一些事,叫做后置操作

🌰举例:Apifox调用开放接口,前置操作获取数据参数加上密钥生成MD5签名,并请求接口

1、前置操作

点击前置操作

// 获取参数
var body = pm.variables.replaceIn(pm.request.body.raw);
// 转成JSON对象
var jsonData = JSON.parse(body);
// 拼接密钥并取MD5
let sign = CryptoJS.MD5(body+'z61IdxQp9zsSGQ3').toString().toUpperCase();
// 将签名赋值环境变量(详见下方2设置环境变量)
pm.environment.set('weiceSign', sign);

2、设置环境变量
点击【管理环境变量】=》全局变量,设置全局变量weiceSign,对应的是上一步最后将签名赋值环境变量


3、测试

变更参数,发送请求,测试是否能够自动生成头部签名并验证通过


😊总结

不会用工具的程序员不是个好厨师

工欲善其事必先利其器,通过此篇文章,简单总结了一下本狗工作中工具的使用方式。从三个方面作为切入点,分别讲解了Apifox目录如何分层整理;管理环境的灵活使用;前置/后置操作的配合应用。希望可以通过此水文让更多博友更加熟悉运用手里中的"兵器,让其发挥更大的作用。


🍯猜你喜欢

文章推荐

【项目实战】SpringBoot+uniapp+uview2打造H5+小程序+APP入门学习的聊天小项目

【项目实战】SpringBoot+uniapp+uview2打造一个企业黑红名单吐槽小程序

【模块分层】还不会SpringBoot项目模块分层?来这手把手教你!


目录
相关文章
|
存储 设计模式 人工智能
规范:前端代码开发规范
规范:前端代码开发规范
1586 0
|
测试技术
Apifox
体验了一款神器
477 0
Apifox
|
3月前
|
监控 数据可视化 测试技术
Apifox 如何进行 API 自动化测试?经验之谈
选择 Apifox 来进行 API 自动化测试能够确保每次迭代的质量,避免引入新的 bug,还要实现自动化测试、定时测试、产品监控、可视化测试、持续集成等,帮助提高效率,通过设计和执行有针对性的测试用例,来全面验证产品功能,确保软件系统能够正常运行,减少上线后的问题。
Apifox 如何进行 API 自动化测试?经验之谈
|
6月前
|
前端开发
阿萨学工具:Apifox的高级Mock 功能
阿萨学工具:Apifox的高级Mock 功能
184 0
|
6月前
阿萨学工具: Apifox 的自定义智能Mock功能
阿萨学工具: Apifox 的自定义智能Mock功能
237 0
|
6月前
阿萨学工具: Apifox 的智能Mock功能
阿萨学工具: Apifox 的智能Mock功能
115 0
|
6月前
|
移动开发 小程序 JavaScript
【uniapp 小程序开发页面篇】代码编写规范 | 页面编写规范 | 小程序API
【uniapp 小程序开发页面篇】代码编写规范 | 页面编写规范 | 小程序API
293 0
|
API 数据安全/隐私保护 网络架构
接口文档编写规范(前后端分离项目接口api)
接口文档编写规范(前后端分离项目接口api)
486 0
|
存储 JSON NoSQL
|
算法 IDE 程序员
代码编写规范
代码编写规范