前言

原因

好的工具就要配好的玩法

起因是最近在回顾我的项目时,看到了年事已高并且长时间不必的Postman,发现之前本人整顿的接口文档非常凌乱且没有法则。遂关上当初应用的Apifox,将本狗目前我的项目中应用Apifox的整顿标准和应用办法分享给大家,心愿能有些许帮忙。


次要指标

实现3大重点

1. 如何在Apifox整顿目录
2. 长于应用治理环境
3. 灵便应用前置/后置操作

注释

1.Apifox整顿目录

整顿前的Postman接口目录

整顿后的Apifox接口目录

有的小伙伴可能感觉这整顿前和整顿后没啥区别,反正就是工具,怎么用怎么难受。

此话对否?十分对!但只是出于短平快的开发周期来讲没有任何故障。如果是一个长期迭代,而且流程打算很正规的产品来讲,就显得有些横七竖八。

本狗就是一个鲜活的例子,总是感觉每次迭代规整接口费时费力,然而理论划分为每个迭代版本后如果某个版本接口有问题,翻一下接口文档即可轻松定位。不仅好看还很省时省力,本人写起来也舒心。

所以,本狗的整顿目录策略依照我的项目大分类,而后依据不同迭代版本退出前缀,如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. 点击右上角【治理环境变量】
  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);// 拼接密钥并取MD5let sign = CryptoJS.MD5(body+'z61IdxQp9zsSGQ3').toString().toUpperCase();// 将签名赋值环境变量(详见下方2设置环境变量)pm.environment.set('weiceSign', sign);

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


3、测试

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


总结

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

工欲善其事必先利其器,通过此篇文章,简略总结了一下本狗工作中工具的应用形式。从三个方面作为切入点,别离解说了Apifox目录如何分层整顿;治理环境的灵便应用;前置/后置操作的配合利用。心愿能够通过此水文让更多博友更加相熟使用手里中的"兵器,让其施展更大的作用。


猜你想问

如何与狗哥分割进行探讨

关注公众号【JavaDog程序狗】

公众号回复【入群】或者【退出】,便可成为【程序员学习交换摸鱼群】的一员,问题轻易问,牛逼轻易吹。

此群劣势:

  1. 技术交换随时沟通
  2. 任何私活资源收费分享
  3. 实时科技动态领先通晓
  4. CSDN资源收费下载
  5. 自己所有源码均群内开源,可收费应用

    2.踩踩狗哥博客

    javadog.net

    大家能够在外面留言,随便施展,有问必答


猜你喜爱

文章举荐

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

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

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

【ChatGPT】手摸手,带你玩转ChatGPT

【ChatGPT】SpringBoot+uniapp+uview2对接OpenAI,带你开发玩转ChatGPT