前言
项目大多使用 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。