前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >猿如意中的【ApiFox】工具的安装与使用教程,超详细,保姆级教程看这一篇文章就够了。

猿如意中的【ApiFox】工具的安装与使用教程,超详细,保姆级教程看这一篇文章就够了。

作者头像
跟着飞哥学编程
发布2022-12-15 15:12:51
1.8K0
发布2022-12-15 15:12:51
举报

目录

一、什么是猿如意

二、猿如意中下载安装 ApiFox

2.1、如何下载和安装

 2.2、什么是 ApiFox?

 三、关于 ApiFox 的介绍以及使用

1、基本介绍 

2、支持API文档导入

3、接口管理

3.1、 接口设计

3.2、 接口调试

4、自定义脚本

5、前端 Mock 数据

6、彩蛋

最后


一、什么是猿如意

程序员的如意兵器,你值得拥有。工具代码一搜就有。

猿如意是一款面向开发者的辅助开发工具箱,包含了效率工具开发工具下载,教程文档代码片段搜索,全网搜索等功能模块。帮助开发者提升开发效率,帮你从“问题”找到“答案”。

猿如意的下载与安装:

1)打开猿如意官方下载链接:

猿如意-程序员的如意兵器,工具代码,一搜就有猿如意是一款面向开发者的辅助开发工具箱,包含了效率工具,开发工具下载,文档教程,代码片段搜索,全网搜索等功能模块.帮助开发者提升开发效率,帮你从“问题”找到“答案”.

https://devbit.csdn.net/?source=csdn_community2)根据自己的操作系统点击相应的图标下载即可,我这里是 Windows 系统。

 3)下载完成后,可以看到本地目录有一个 exe 格式的文件,双击安装即可。

 4)运行猿如意,界面如下。

 良心话,这款桌面软件真的非常不错,简直就是程序员的梦工厂。应有尽有,只有你想不到,没有猿如意做不到的。

二、猿如意中下载安装 ApiFox

2.1、如何下载和安装

1)找到你要下载的工具,点击获取

2)下载完成后,右侧按钮变为文件,点击文件即可查看下载好的目录位置

 找到压缩包,并解压

3) 这里就是我们今天要安装的软件,同样的配方,用你发财的小手,双击 666 即可。

 点击下一步,安装目录,可以用默认的,也可以自定义安装到指定目录下。

 点击安装,会看到带有安装进度条的界面

4)最后安装完毕,就可以运行啦…… 

 这个就是我们下载好的 ApiFox 工具界面。是不是非常的简约又大气呢。

 2.2、什么是 ApiFox?

让你直呼哇塞的 Api 管理神器 Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台,定位 Postman + Swagger + Mock + JMeter。一站式服务解决多个系统之间的数据同步问题。

 三、关于 ApiFox 的介绍以及使用

作为开发者,包括前端、后端、测试人员最离不开的一个工具就是 Postman,方便我们用来做API接口进行调试。但 Postman并不完全符合我们对API的各种需求,比如维护API文档、API Mock、API自动化测试等等。最近发现一款API一站式服务的工具:Apifox,毫不夸张的说吊打Postman!

1、基本介绍 

官网界面

首先我们需要创建一个团队,Apifox支持团队管理,你可以把自己团队的小伙伴邀请加入进来。而且支持云端数据共享!方便团队成员间协作

创建团队🔧

然后我们在该团队中创建项目,Apifox的项目进行权限管理(比如管理员设置、只读权限等等)

创建项目📚

创建项目成功,我们开始进行体验Apifox强大的功能!

Apifox很体贴,提供了一个宠物商店完整CRUD的API Demo给用户使用,方便新用户第一时间可以通过Demo尝鲜!如下图👇

Demo 尝鲜

2、支持API文档导入

Apifox支持导入Swagger、Postman、RAP2、JMeter、YApi、Eolinker、Apizza、ShowDoc、apiDoc等多达20种工具的导入。看得出市场上大部分数据类型Apifox都兼容了,我们再也不用担心数据迁移的问题了!

接下来聊聊如何通过Apifox导入接口文档

通过点击下图所示的导入按钮 👇

导入接口文档📒

然后在导入界面中的数据格式选项中选择Swagger,并选中URL导入Tab按钮,最后输入Swagger的数据Url即可 👇

导入接口文档📒

成功导入后,将会显示导入预览面板,显示内容包括:要导入的接口、数据模型等,Apifox将会把我们接口返回的实体类转换为数据模型,方便下次复用

生成接口数据

当完成以上步骤后就可以开始调试接口了。下图中我们可以发现APifox对查看文档和修改文档分成两个Tab模块,方便我们管理接口文档。

3、接口管理

玩转上面的流程后,我们开始核心基础功能的体验。比如单个接口的编辑与调试

3.1、 接口设计

接口离不开接口请求参数,以及各个参数的说明。而这方面Apifox界面中的参数说明很详细!

请求参数界面

讲完请求参数,我们看下返回结果界面,结果呈现树状结构,重点是支持折叠。国内大多同类型软件都是没有的!

返回结果界面

最后我们看下另外一个Tab功能模块修改文档,支持状态修改、分组和标签功能

3.2、 接口调试

说到接口调试,我相信你一定会第一想到postman,但是你可能还不知道我们国人做的Apifox功能比Postman更强大

Apifox支持环境配置,默认给我们设定了三种环境:正式环境测试环境Mock服务。方便我们在开发接口时,针对不同环境的场景可以做相应的配置

多种环境支持

当你开始调试接口之前,我们需要先配置好环境所定义的 前置Url, 这里以正式环境为例

设置前置Url

同时Apifox支持在接口调用前、接口调用返回后,做一些自定义操作。在Apifox界面中分别称为前置操作后置操作。以后置操作作为例子

前置操作 & 后置操作

我们在其中一个接口的后置操作中添加一个断言,假若接口返回 code=200, 则表示操作成功

支持断言

最后我们调用该接口,来验证下这个功能!发现断言结果跟我们预期不一致!

4、自定义脚本

前文我们介绍了Apifox强大的前置操作、后置操作功能,支持自定义,不仅仅支持简单的断言和提取变量,还能自定义脚本(自己编写JS文件)

支持自定义脚本 ✏️

同样,我们用上述的自定义脚本来校验我们的接口返回数据

5、前端 Mock 数据

Mock数据也是Apifox强大的功能之一,号称零配置即可生成非常人性化的mock数据。

那我们来看看Apifox都内置了哪些智能规则 👇

预设Mock规则

其中有一个特别有爱的规则是@image,我们根据选择不同尺寸mock出不同的图片 如下图配置👇

Mock 图片 🖼️

当你觉得Apifox内置的Mock功能不够满足你的应用场景,我们又可以自定义了,支持前端熟悉的Mock.js 语法编写mock规则 👇

支持Mockjs拓展 🔧

当你完成mock规则配置之后,只需将环境切换到Mock服务就可以开始调用Mock数据接口了!

接下来我们来看下通过Apifox Mock的数据是不是正如官网所说的人性化? 👇

人性化的Mock数据 🤩

哇!无论是图片、ID还是数组对象中的数值,都按照我期望的格式返回了Mock数据。

如果官方默认预设的Mock规则,还无法满足你的场景,你再结合上文提到的通过Mockjs来自定义规则就可以了。

6、彩蛋

Apifox除了拥有强大的功能之外,最吸引我的地方还有交互与设计。甚至还支持主题选择,我个人偏向使用官方默认的背景“暗色”及主色“湖蓝”的搭配

最后

Apifox除了具备强大的功能之外,UI界面交互设计也是国内同类型软件无法媲美的。Postman有的接口调试功能它基本都有,还集成了Mock数据、API文档管理、自动化测试等等功能。而且扩展性也很好,比如自定义脚本、前置操作、后置操作等等。相信你体验完,你一定直呼哇塞!🤩

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2022-12-10,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 一、什么是猿如意
  • 二、猿如意中下载安装 ApiFox
    • 2.1、如何下载和安装
      •  2.2、什么是 ApiFox?
      •  三、关于 ApiFox 的介绍以及使用
        • 1、基本介绍 
          • 2、支持API文档导入
            • 3、接口管理
              • 3.1、 接口设计
              • 3.2、 接口调试
            • 4、自定义脚本
              • 5、前端 Mock 数据
                • 6、彩蛋
                  • 最后
                  领券
                  问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档