我正在参与掘金创作者训练营第4期,点击了解活动详情,一起学习吧!
一、APIfox初了解
我们平时在开发项目的过程中,肯定会用到postman,用来测试接口,查看是否能调用。我们也会用到mock.js,用来模拟数据。如果是一名后端,也会用到swagger,用来生成接口文档。如果你是一名测试,那么你也会用到Jmeter,用来自动化测试接口。如果你是一名全栈全流程独立开发者,或者你想独立开发一个项目,那么现在起你不用在需要同时使用这四种工具,APIfox可以直接帮你搞定。
APIfox=postman +mock.js + swagger + Jmeter
APIfox就是把上述四个功能整合在一起,但是又不只是简简单单的整合,我们可以在体验中自行体会,最重要的一点事,他是我们国人开发的,对我们国人的使用特别的友好。
我们可以点击下面得链接,进入官网下载及了解相关特性。
二、APIfox初体验
我会带你了解一下APIfox的基本使用过程,让你有一个初步的认识和了解。
2.1 页面基本功能
首先,我们选择我们需要的方式自行登陆。
登陆之后,就进入到APIfox的首页
进入到页面内,我们点击示例项目,可以先简单链接一下基本功能。可以看到左侧为我们提供了一下增删改查的基本功能。
2.2 接口文档页面
我们点击一下查询宠物详情,进入到接口文档页面内,我们看到接口的一些相关信息,包括名称、状态、创建人、时间、mock数据,以及下滑看到的请求参数,返回结果、返回示例。
2.3 运行页面
紧接着,我们点击运行,就进入到运行页面,乍一看,这不就是postman么,没错,这个页面和postman极为相似,我们在这里可以进行接口的请求与状态查看,
比如我们随机查看一个MocK数据,看一下。首先我们需要在右上角选择我们的使用环境,之后点击运行,就可以查看接口的相关信息
2.4 文档相关操作
当我们接口调试完成时,就会自动生成对应的文档,我们可以把文档分享给前端或其它小伙伴,方便进行联调测试
点击左上方的项目概览
进入到项目概览页面,点击新建分享
我们可以设置一些分享相关的配置,选择分享给谁,设置密码、文档过期时间以及要分享的接口。设置完成后最后点击保存,
下面得就是我们设置好的分享,我们可以看到一些我们设置的信息,点击右侧三个点复制链接,把接口发给对应的小伙伴
下面就是我们小伙伴通过链接查看到的文档
同时我们也可以修改我们的文档,我们可以修改对应的参数,以及进行一些mock相关的操作
2.5 自动化测试
点击左侧边栏的自动化测试,进项相关操作。
我们可以新建一个自动化测试接口,批量测试接口的状态。填完相关信息后,点击确定。
我们看到了我们新建好的测试用例,点击详情,进入到如下页面
进入到相应页面后,点击添加步骤,选择从接口用例导入,导入我们需要的接口。选择相应的模式,复制就是会不干扰,绑定就是和前面的接口数据相关。我们选择复制,点击确定。
点击运行按钮
就会生成相应的接口报告,我们可以查看响应的信息
2.6 总结
上述的四个功能其实在团队协作之间会显得十分的便捷高效,对于个人的使用也会十分的友好,我们不用再频繁的切换相应的软件。同时文档的结实更新等都会减少我们的沟通成本,节约时间。
三、新建项目接口
之前的接口都是本事自带的示例。我们可以新建一个项目,体验一下新建的流程是如何操作的。点击加号,我们选择新建接口,
进入到如下界面,我们可以设置相应的接口内容
我们同时可以看到,我们接口后面有id时,会自动生成path的相关信息,
我们也可以设置我们的返回结果,点击确定
点击确定后,我们可以看见我们的设置,同样可以进行相应的配置
点击添加示例
进入到添加示例页面,我们可以选择成功还是失败的示例,之后点击自动生成,就会按照我们上面的数据结构相应的mock数据。点击确定
我们也可以把我们的某个参数设置为固定,比如我们让status一直是0,我们通过如下设置
之后点击示例下边的修改,在自动生成,会发现status一直都是0
之后我们点击保存,就可以在右侧成功创建我们的接口
保存后回到如下页面,点击右上方运行,
点击发送至后,点击保存为用例
可以选择这个数据是什么用例,我们选择成功
左侧就会对应生成成功案例
总结
上述就是我们对APIfox的初步认识与体验,其实APIfox的强大远远不止这些,它还可以添加后置操作,也可以写脚本对返回结果进行处理等等操作。
最后,这篇文章知识自我使用的一个基本记录,目的是加深印象,逻辑不是很紧密,深感抱歉,欢迎批评指教。有喜欢的小伙伴可以点赞支持一下,不胜感激。