YAPI--撰写接口文档的平台

「爱情、让人受尽委屈。」 2024-03-22 12:21 38阅读 0赞

### 1 YAPI ###

#### 1.1 YAPI介绍 ####

在前后台分离开发中，我们前后台开发人员都需要遵循接口文档，所以接下来我们介绍一款撰写接口文档的平台。

YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。

其官网地址：[http://yapi.smart-xwork.cn/][http_yapi.smart-xwork.cn]

YApi主要提供了2个功能：

*  API接口管理：根据需求撰写接口，包括接口的地址，参数，响应等等信息。
 *  Mock服务：模拟真实接口，生成接口的模拟测试数据，用于前端的测试。

#### 1.2 接口文档管理 ####

接下来我们演示一下YApi是如何管理接口文档的。

首先我们登录YAPI的官网，然后可以直接使用百度账号登录，没有的话去注册一个，如下图所示：

![在这里插入图片描述][1d151c1435144153abe9fdb78bfb5009.png]

![在这里插入图片描述][74b7970a489049b58785268052c697b3.png]

登录进去后，在个人空间中，选择项目列表->添加测试项目，效果如图所示：

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Uc0evPIk-1683254031253)(assets/1669198453566.png)\]][img-Uc0evPIk-1683254031253_assets_1669198453566.png]  
输入项目名称，点击创建  
![在这里插入图片描述][af42d40cda7e48b9abff02a9124123b2.png]

然后点击创建的项目，进入到项目中，紧接着先添加接口的分类，如下图所示

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-lfBu74Nl-1683254031253)(assets/1669198630531.png)\]][img-lfBu74Nl-1683254031253_assets_1669198630531.png]  
添加用户管理分类  
![在这里插入图片描述][d5cb76cd0e9043fdaa6454d9f79a0bd1.png]

然后我们选择当前创建的分类，创建接口信息，如下图所示：

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-5zYR12Kz-1683254031253)(assets/1669289187162.png)\]][img-5zYR12Kz-1683254031253_assets_1669289187162.png]  
添加完成后如下图所示  
![在这里插入图片描述][60b51ebccf9f47bb954169b215644198.png]  
点击编辑  
![在这里插入图片描述][ec0d55b5330a4a09a1b37e98f6463868.png]

添加接口的请求参数，如下图所示：

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-ulrCaTZC-1683254031255)(assets/1669289410729.png)\]][img-ulrCaTZC-1683254031255_assets_1669289410729.png]

添加接口的返回值，如下图所示：

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-u4m9kpFb-1683254031255)(assets/1669289514661.png)\]][img-u4m9kpFb-1683254031255_assets_1669289514661.png]  
添加备注信息，然后点击保存  
![在这里插入图片描述][ea19b57bf062468eaa76f1c804443b90.png]

然后保存上述设置，紧接着我们可以来到接口的预览界面，查询接口的信息，其效果如下图所示：

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-7Y5pBY0k-1683254031256)(assets/1669289623957.png)\]][img-7Y5pBY0k-1683254031256_assets_1669289623957.png]  
![在这里插入图片描述][2904675b1f2546ee802cfe6233bdc8ba.png]  
点击Mock地址可以直接访问到json数据  
![在这里插入图片描述][7ab7a242fb27425f8b59d965a0fac9ea.png]

最后，我们还可以设置接口的mock信息，

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-hq0JS7Bv-1683254031257)(assets/1669289857670.png)\]][img-hq0JS7Bv-1683254031257_assets_1669289857670.png]

来到接口的Mock设置窗口，如下图所示：

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-IHMicKvu-1683254031257)(assets/1669290093854.png)\]][img-IHMicKvu-1683254031257_assets_1669290093854.png]

紧接着我们来到接口的预览界面，直接点击Mock地址，如下图所示：

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-UvREX5sV-1683254031258)(assets/1669290162900.png)\]][img-UvREX5sV-1683254031258_assets_1669290162900.png]

我们发现浏览器直接打开，并返回如下数据：

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-qNZzlu8m-1683254031258)(assets/1669290210749.png)\]][img-qNZzlu8m-1683254031258_assets_1669290210749.png]

以上步骤就是YAPI接口平台中对于接口的配置步骤。

[http_yapi.smart-xwork.cn]: http://yapi.smart-xwork.cn/
[1d151c1435144153abe9fdb78bfb5009.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/e22c77d66b2d49778c7e38a7346977a9.png
[74b7970a489049b58785268052c697b3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/bb405cf1f0a64aaaafb72adb11e1b8cb.png
[img-Uc0evPIk-1683254031253_assets_1669198453566.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/b4936f0c122b4176b98de44aad1e4c17.png
[af42d40cda7e48b9abff02a9124123b2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/703d3835bc294ec2bb1469bbf011a3bc.png
[img-lfBu74Nl-1683254031253_assets_1669198630531.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/b7cd47e4d57d4a0c8f8ea9ab4eace634.png
[d5cb76cd0e9043fdaa6454d9f79a0bd1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/5fcc7b1fd50645aeb7e872b251787609.png
[img-5zYR12Kz-1683254031253_assets_1669289187162.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/8c520eff0dbd4dd0872d1b6c58706d57.png
[60b51ebccf9f47bb954169b215644198.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/0b9c683ab6f741fdba0d613075c1a3b4.png
[ec0d55b5330a4a09a1b37e98f6463868.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/2993e6f6f268408ba588afbc90ff5dfd.png
[img-ulrCaTZC-1683254031255_assets_1669289410729.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/a773831e4a4e47488b22a88cd76f8ca0.png
[img-u4m9kpFb-1683254031255_assets_1669289514661.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/9236c50d08c04c3c8e656af1531d5834.png
[ea19b57bf062468eaa76f1c804443b90.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/9183532bf6c84f3f8269be7e4087fa29.png
[img-7Y5pBY0k-1683254031256_assets_1669289623957.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/781f082f4929410d85e89280dddc7847.png
[2904675b1f2546ee802cfe6233bdc8ba.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/b6afe3f8eb0a4d829b66ceac1280e5d1.png
[7ab7a242fb27425f8b59d965a0fac9ea.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/79579ca98ef9409daafe5ce27a86d8ac.png
[img-hq0JS7Bv-1683254031257_assets_1669289857670.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/612203ced6374f888ccaf277c7a5133d.png
[img-IHMicKvu-1683254031257_assets_1669290093854.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/9ac7f569249d4a9e863046445d5665ac.png
[img-UvREX5sV-1683254031258_assets_1669290162900.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/ffbd4d9c597b40d998689d61cdc727aa.png
[img-qNZzlu8m-1683254031258_assets_1669290210749.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/8eabc4c0fdae4f028409cb6f77c4f63f.png