一、什么是Apifox

Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台,定位 Postman + Swagger + Mock + JMeter。通过一套系统、一份数据,解决多个系统之间的数据同步问题。只要定义好 API 文档,API 调试、API 数据 Mock、API 自动化测试就可以直接使用,无需再次定义;API 文档和 API 开发调试使用同一个工具,API 调试完成后即可保证和 API 文档定义完全一致。高效、及时、准确!
官方文档:https://www.apifox.cn/help/app/introduce/

二、如何利用Apifox生成接口文档

1、准备

(1)下载Apifox客户端
image.png
(2)下载 VS Code(https://visualstudio.microsoft.com/zh-hans/downloads/
image.png
(3)准备一个Web Api的项目(这里我以手上项目的自定义接口为例)
image.png

2、Swagger Api接口导入Apifox客户端

创建项目
image.png
image.png
点击进入项目,然后进行接口数据导入
image.png
注:导入有手动和自动两种,如果接口有发布到固定的地址,建议使用自动。这里是演示,所以选择了手动。
导入的URL是接口中的swagger.json!!!
image.png
导入后即可设置环境变量,进行接口调用
image.png

3、Apifox导出接口文档

image.png
官方给出的文档中明确说明无法导出PDF、Word,而可以导出Markdown格式,那就只能将.md文件转换为pdf,从而实现导出PDF(Word还没找到转换的方法!),操作如下:
(1)导出Marddown文件
image.png
(2)打开VS Code 安装两个插件(markdown pdf 插件和markdown Preview enhanced插件),安装完成后,关闭Vscode 后重启。
image.png
image.png
(3)VsCode中打开Marddown文件,在xx.md代码编辑区,右键单击弹窗中选择Markdown Preview Enhanced功能键。
image.png
(4)进行格式转换。在右边预览窗口出现的图文版md文件中,右键单击出现勾选菜单,选择chrome>> PDF,或者jpeg、png格式,将在当前目录下生成xx.pdf或者xx.jpeg文件。
image.png
这里就是相应的PDF接口文件
image.png