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

1 YAPI

1.1 YAPI介绍

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

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

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

YApi主要提供了2个功能：

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

1.2 接口文档管理

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

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

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

输入项目名称，点击创建

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

添加用户管理分类

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

添加完成后如下图所示

点击编辑

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

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

添加备注信息，然后点击保存

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

点击Mock地址可以直接访问到json数据

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

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

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

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

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