【ApiFox的简单使用】

淩亂°似流年 2023-10-01 19:43 5阅读 0赞

### ApiFox的使用 ###

*   *  使用背景
     *  前期准备
     *  创建一个post接口
     *  生成在线文档
     *  注意

## 使用背景 ##

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

## 前期准备 ##

1.  **下载**  
    网址：https://www.apifox.cn/ ，支持 linux、mac、windows多平台
2.  **登录使用**  
    安装成功后，首次启动需要注册登录
3.  **环境管理**  
    登录成功后可以看到ApiFox提供了一个**宠物店**的示例，整体页面风格和postman很接近。
    
    我们可以在右上角进行环境的管理。  
    ![示例图1][1]![示例图2][2]

## 创建一个post接口 ##

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

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

## 生成在线文档 ##

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

## 注意 ##

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

[1]: https://img-blog.csdnimg.cn/e15b3f7313584ac6b004241571283345.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA54yr6aWtX0FDRQ==,size_20,color_FFFFFF,t_70,g_se,x_16
[2]: https://img-blog.csdnimg.cn/7fc270c9a63840f2ba55377ff3d81d66.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA54yr6aWtX0FDRQ==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA54yr6aWtX0FDRQ_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/a17be20de2d14734a257c0dc08df2d1d.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA54yr6aWtX0FDRQ==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA54yr6aWtX0FDRQ_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/c5a215007b7047ec9d1016c9c1b4e3a6.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA54yr6aWtX0FDRQ==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA54yr6aWtX0FDRQ_size_20_color_FFFFFF_t_70_g_se_x_16 2]: https://img-blog.csdnimg.cn/96f3ff42b19b484cb563075f1c068d79.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA54yr6aWtX0FDRQ==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA54yr6aWtX0FDRQ_size_20_color_FFFFFF_t_70_g_se_x_16 3]: https://img-blog.csdnimg.cn/b728505b1c864aee80b7f5ceec24bef5.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA54yr6aWtX0FDRQ==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA54yr6aWtX0FDRQ_size_20_color_FFFFFF_t_70_g_se_x_16 4]: https://img-blog.csdnimg.cn/878c02a928474482a22b16f6b6a92192.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA54yr6aWtX0FDRQ==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA54yr6aWtX0FDRQ_size_20_color_FFFFFF_t_70_g_se_x_16 5]: https://img-blog.csdnimg.cn/37e673f8435149869c859f3cb043617b.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA54yr6aWtX0FDRQ==,size_20,color_FFFFFF,t_70,g_se,x_16