YApi 自动生成接口文档

YApi

YApi 是什么

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

YApi 特性

它都有哪些特性呢？如下

• 接口支持可视化

• 拥有 Mock 功能

• 具备测试接口的能力

• 支持导入一些格式的 api 文件

• 可以本地部署

YApi 界面

使用

这里就拿 Docker + Nodejs 来举例吧~

Docker 安装 YApi

通过 docker 安装：https://github.com/Ryan-Miao/docker-yapi

安装 Nodejs

需要到 Nodejs 的官网，下载 stable 版本，也就是稳定版

安装 MongoDB

到 MongoDB 的官网下载，安装的话一直下一步下一步就行了

npm 安装 YApi

在终端里运行

安装后会启动 yarpi server ，端口号是 9090

部署 Yapi

然后需要部署一下，这样才能在本地访问 Yapi 文档

点击 开始部署 后，会出现密码和用户名。可以记起来

本地运行 YApi

进到 Yapi-cli 目录，运行

这个时候浏览器的 3000 端口会运行 YApi 文档

跨域插件

如果想要在浏览器 YApi 访问到本地接口，需要安装 Yapi 提供的谷歌插件~

导出导入

YApi 也支持导入导出数据，便于项目跨平台迁移

知识扩展：了解更多关于 YApi 的使用技巧！

• YApi Mock服务的使用教程
  

• 使用YApi实现接口自动化测试的技巧与方法