Yapi使用（快速入门）

介绍

YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

YApi让接口开发更简单高效，让接口的管理更具可读性、可维护性，让团队协作更合理。

源码地址: GitHub - YMFE/yapi: YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台

源码地址图例

​

 官方文档: YApi 接口管理平台

使用网址  zayapi.smart-xwork.cn/

YApi 接口管理平台 （最新）

 

使用

1、使用 zayapi.smart-xwork.cn/

注意：YApi 的接口测试等功能仅支持 Chrome 浏览器，请使用 Chrome 浏览器获得完整功能。

​

 2、点击百度pass进行登录（点击百度pass登录后，按照要求进行相关登录，输入个人相关百度账号和密码、没有百度账号和密码的读者朋友，请自行注册！！！）

3、登录到Yapi平台之后，我们可以创建项目，在项目下创建接口分类，在对应的分类中添加接口。

​

4、创建项目

​

 5、添加分类

​

 6、添加接口

​

 ​

 可参考图例

​

 7、接口基本信息录入之后，添加提交，就可以看到该接口的基本信息：

​

 但是目前，接口中我们并未指定请求参数，响应数据等信息，我们可以进一步点击编辑，对该接口 详情进行编辑处理。

​

 8、请求参数设置​

 9、返回数据设置

​

10、运行接口

Yapi也提供了接口测试功能，当我们接口编辑完毕后，后端服务的代码开发完毕，启动服务，就可以使用Yapi进行接口测试了。

​

导出接口文档

在Yapi平台中我们不仅可以在线阅读文档，还可以将Yapi中维护的文档直接导出来，可以导出md，json，html格式，在导出时自行选择即可 。

​

 而在导出的html文件或md文件中，主要描述的就是接口的基本信息， 包括： 请求路径、请求方式、接口描述、请求参数、返回数据等信息。展示形式如下：

​

导入接口文档

上述我们讲解了接口文档的导出，我们也可以将外部的接口文档导入到Yapi的平台中，这样我们就不用一个接口一个接口的添加了。我们可以将json格式的接口文档直接导入Yapi平台中来。

​

 导入过程中出现的确认弹窗，选择"确认"。

​

 导入成功之后，我们就可以在Yapi平台查看到已导入的接口。