【强烈推荐!!!】Apifox安装及使用

前言

项目大多使用 Swagger 实现 RESTful API 的接口文档,虽说是节省了大量手写接口文档的时间,但是它导出的接口文档没有排版,格式并不能直接作为接口文档归档,听说现在大厂流行使用Apifox,今天试用了一下,除了颜值在线,功能也是很齐全哇,可以使用 Apifox工具将项目中的接口导入Apifox,开发调测,自动化测试及导出归档。下面我们来看下吧~

下载及安装

点击 Apifox 首页,下载对应的 Apifox 桌面版,安装点点点即可。
地址:https://apifox.com
如下图所示:
在这里插入图片描述

API导入

点击「个人空间」-「新建项目」,双击进入新建的项目,
在这里插入图片描述
点击「个人项目」,再点击「+」按钮,选择「导入」选项。在这里插入图片描述
导入数据选择「OpenAPI/Swagger」,导入方式选择「URL 方式导入」,填写自己项目中Swagger 数据 URL,启动需要导入接口的工程,点击「提交」。在这里插入图片描述再点击「确认导入」按钮,完成 API 接口的导入。在这里插入图片描述

API查看

点击「管理后台-认证」的「使用账号密码登录」接口,查看该 API 接口的定义。
在这里插入图片描述

API调试

点击右上角「请选择环境」,再点击「管理环境」选项,填写测试环境的地址,并进行保存。
在这里插入图片描述
根据项目中swagger注解写的参考值及说明填写header、body,调测接口。
在这里插入图片描述

API导出

右键点击某个接口「请选择环境」,再点击「导出」选项,按照自己想要的风格导出API文档。Apifox 支持以 OpenAPI (原 Swagger风格)、HTML、Markdown、Apifox 等数据格式导出接口,个人感觉Markdown和HTML格式的比较适合归档,后续还会支持Word、PDF格式,一整个期待住了。
在这里插入图片描述

更多

本人只是作为开发体验了一下Apifox,更多玩法可查看官方帮助文档,地址:https://apifox.com/help。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
安装和配置 Apifox 需要进行以下步骤: 1. 访问 Apifox 网站:首先,您需要访问 Apifox 官方网站(https://www.apifox.cn/),并注册一个账号。 2. 创建项目:在 Apifox 中,您可以创建多个项目来管理您的接口文档和测试。登录后,点击"新建项目"按钮,填写相关信息并创建一个项目。 3. 添加接口:在项目中,您可以添加接口来描述您的 API。点击"新建接口"按钮,填写接口的名称、URL、请求方法等信息,并添加请求参数、响应数据等。 4. 配置环境变量:在 Apifox 中,您可以配置不同的环境变量,以便在不同环境下使用不同的请求地址。例如,您可以配置一个测试环境和一个生产环境,并分别设置对应的请求地址。在接口编辑页面中,您可以点击"环境变量"标签页来配置环境变量。 5. 导出文档:当您完成接口的编辑和配置后,可以导出接口文档。在项目中,点击"导出文档"按钮,选择导出的格式(如 Markdown、HTML)并进行导出操作。 6. 其他功能:除了以上基本功能外,Apifox 还提供了许多其他有用的功能,如接口测试、Mock 数据生成、权限管理等。您可以根据自己的需求进一步使用和配置这些功能。 注意:Apifox 是一个在线的接口管理工具,无需在本地安装。您只需在浏览器中访问 Apifox 网站,创建账号并配置您的接口和项目即可使用。 希望以上信息对您有所帮助!如有更多问题,请随时提问。

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值