【ApiFox的简单使用】

使用背景

由于本公司并没有用到前后端+测试的协同开发,所以鄙人在此使用ApiFox只是用来进行后端自测+给前端提供在线的mock文档使用。

前期准备

  1. 下载
    网址:https://www.apifox.cn/ ,支持 linux、mac、windows多平台

  2. 登录使用
    安装成功后,首次启动需要注册登录

  3. 环境管理
    登录成功后可以看到ApiFox提供了一个宠物店的示例,整体页面风格和postman很接近。

    我们可以在右上角进行环境的管理。
    示例图1示例图2

创建一个post接口

和postman相同的地方就不说了,提一下和postman不同的地方,如下图所示,ApiFox是分修改文档运行两部分的。
在这里插入图片描述
修改文档就是可以暴露给前端的接口文档部分,可在其中定义出入参的字段和样例,上图中展示了一个json格式的入参;

运行部分就和postman类似,如下图所示:
在这里插入图片描述
对于修改文档部分需要注意的是:入参、出参、入参示例、出参示例 都是需要进行填写补充的,否则生成的在线文档中会有相应的缺失。下图对应的是相应的出参和出参示例:
在这里插入图片描述

生成在线文档

项目概览中的在线分享中可创建给前端的在线接口文档。点击新建分享下的省略号可复制链接。
在这里插入图片描述可以对过期时间、分享范围等进行选择。
在这里插入图片描述最后访问链接可查看生成的在线文档。
在这里插入图片描述

注意

Apifox的mock原理是在本地启动了一个web服务,若关闭了Apifox,接口也将无法访问,所以在调试接口时,记得保持Apifox一直在运行中。

  • 1
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 2
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值