【规范】Apifox就应该这么玩

﹏ヽ暗。殇╰゛Y 2024-05-11 09:07 63阅读 0赞

### 前言 ###

#### ?缘由 ####

##### 好的工具就要配好的玩法 #####

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

--------------------

#### ?主要目标 ####

##### 实现3大重点 #####

###### 1. 如何在Apifox整理目录 ######

###### 2. 善于使用管理环境 ######

###### 3. 灵活使用前置/后置操作 ######

### 正文 ###

#### ?1.Apifox整理目录 ####

##### 整理前的Postman接口目录 #####

![在这里插入图片描述][1a296918ee6945a7ba01d373f8c8a1f0.png]

##### 整理后的Apifox接口目录 #####

![在这里插入图片描述][3c1ba16f5ff34c09888bc16e80769418.png]

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

此话对否？非常对！但只是出于**短平快的开发周期来讲没有任何毛病**。如果是一个长期迭代，而且流程计划很正规的产品来讲，就显得有些杂乱无章。  
![在这里插入图片描述][4f8a6f9c82b7434690e370fc3a29c2db.png]  
本狗就是一个鲜活的例子，总是觉得每次迭代规整接口费时费力，但是**实际划分为每个迭代版本后**，**如果某个版本接口有问题，翻一下接口文档即可轻松定位**。不仅美观还很省时省力，自己写起来也舒心。

![在这里插入图片描述][37d4f197ab514c199dae4daecef9cdb1.png]  
所以，本狗的**整理目录策略按照项目大分类**，然后根据**不同迭代版本加入前缀**，如**v1.0.1-用户-登录，v1.0.1-用户-注册等**

--------------------

#### ?2.管理环境 ####

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

?举例：

用户登录接口：/user/login

*  开发环境 ：https://javadog-dev.com
 *  测试环境 ：https://javadog-test.com
 *  生产环境 ：https://javadog.com

需要组合正确的url，分别是：

*  https://javadog-dev.com/user/login
 *  https://javadog-test.com/user/login
 *  https://javadog.com/user/login

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

##### 如何在环境变量里设置？ #####

1.  点击右上角【管理环境变量】  
    ![在这里插入图片描述][9245206cb251479ea1bc7b9d8645205f.png]
2.  设置服务名，并写入前置URL，并点击【保存】  
    ![在这里插入图片描述][4f35e2c1123b454db23661da29602c8d.png]
3.  重复上述1，2操作，将不同环境的前缀路径分别录入  
    ![在这里插入图片描述][cfe2e984f51a4a4abfccb5080ab2c6a5.png]
4.  在新建接口时，不用写入前缀URL，只需写目标路径即可

![在这里插入图片描述][ab3891f9ff2a4079a90c6270dda134fd.png]

--------------------

#### ?3.前置/后置操作 ####

什么是前置/后置操作？

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

![在这里插入图片描述][c0b083f004e14a1f884b0477bdd0890b.png]  
![在这里插入图片描述][8a4644048d4d4002a9d33e001140906f.png]  
大白话就是：在你**执行接口前**做一些事，叫做**前置操作**；在你**执行接口后**做一些事，叫做**后置操作**

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

1、前置操作

点击前置操作  
![在这里插入图片描述][e69dbf9f5165464982a7bd075cb07ee6.png]

// 获取参数
    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**，对应的是**上一步最后将签名赋值环境变量**

![，][c0cf97f95735440aad2b166b4878f605.png]  
3、测试

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

![在这里插入图片描述][4ee17434f3444792ba21f203dc25dae2.png]

--------------------

### ?总结 ###

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

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

--------------------

#### ?猜你想问 ####

##### 如何与狗哥联系进行探讨 #####

###### 关注公众号【JavaDog程序狗】 ######

公众号回复【入群】或者【加入】，便可成为【程序员学习交流摸鱼群】的一员，问题随便问，牛逼随便吹。  
![在这里插入图片描述][e55c65b223664e6dbed5961ecea0d270.png]

**此群优势：**

1.  技术交流随时沟通
2.  任何私活资源免费分享
3.  实时科技动态抢先知晓
4.  CSDN资源免费下载
5.  本人一切源码均群内开源，可免费使用

###### 2.踩踩狗哥博客 ######

[javadog.net][]

> 大家可以在里面留言，随意发挥，有问必答

![b98f327f0a078f13b2b80f064914d622.png][]

--------------------

#### ?猜你喜欢 ####

##### 文章推荐 #####

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

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

[【模块分层】还不会SpringBoot项目模块分层？来这手把手教你！][SpringBoot]

[【ChatGPT】手摸手，带你玩转ChatGPT][ChatGPT_ChatGPT]

[【ChatGPT】SpringBoot+uniapp+uview2对接OpenAI，带你开发玩转ChatGPT][ChatGPT_SpringBoot_uniapp_uview2_OpenAI_ChatGPT]

--------------------

[dc8c478155724a11a63a332f9e744b67.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/4c718a31686f44dc9b43245e73c258a5.png
[1a296918ee6945a7ba01d373f8c8a1f0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/8035837cd83f47e1a6e7f5020189bcab.png
[3c1ba16f5ff34c09888bc16e80769418.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/4fd8b2499981444da5580c5059bb461b.png
[4f8a6f9c82b7434690e370fc3a29c2db.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/37d3619cbb12408ba3c99345de1f1789.png
[37d4f197ab514c199dae4daecef9cdb1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/9a665197f4054a5d882b925b70fda31d.png
[9245206cb251479ea1bc7b9d8645205f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/e1423d04c0914750996fe9992605c7ab.png
[4f35e2c1123b454db23661da29602c8d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/b5f79d7fd8dc43cc861b74fd0ec632f1.png
[cfe2e984f51a4a4abfccb5080ab2c6a5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/36e3403f9af64bd89d64b355409d8f4c.png
[ab3891f9ff2a4079a90c6270dda134fd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/f54ad8c2ad8a4093a45596e58699c51a.png
[c0b083f004e14a1f884b0477bdd0890b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/f4648d7b6e27419292871c8009f4b8a8.png
[8a4644048d4d4002a9d33e001140906f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/d9d04b403806400c8f2f8a8d798032b1.png
[e69dbf9f5165464982a7bd075cb07ee6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/84e05858bdc14295869aaecf3c8af8bc.png
[c0cf97f95735440aad2b166b4878f605.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/4d6e60c99fcb4355bd6e03fdb966967e.png
[4ee17434f3444792ba21f203dc25dae2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/08f41ff5ee184fe5914e273987bef064.png
[e55c65b223664e6dbed5961ecea0d270.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/d0fc4bd90fb74304aec2ac234170c66b.png
[javadog.net]: https://www.javadog.net/
[b98f327f0a078f13b2b80f064914d622.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/11/af3b6babf25d48c094304c770f05d66f.png
[SpringBoot_uniapp_uview2_H5_APP]: https://mp.weixin.qq.com/s/g7AZOWLgW5vcCahyJDEPKA
[SpringBoot_uniapp_uview2]: https://mp.weixin.qq.com/s/t_qwF_HvkdW-6TI3sYUHrA
[SpringBoot]: https://mp.weixin.qq.com/s/fpkiNR2tj832a6VxZozwDg
[ChatGPT_ChatGPT]: https://mp.weixin.qq.com/s/9wEelbTN6kaChkCQHmgJMQ
[ChatGPT_SpringBoot_uniapp_uview2_OpenAI_ChatGPT]: https://mp.weixin.qq.com/s/b19J36Eo3-ba7bHbWzoZYQ