YApi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。对于经常使用postman的开发人员非常友好, 支持数据导入, 可以无缝集成.
之前使用过的接口文档工具有swagger(丝袜哥) , showdoc + runapi , JApiDocs. 在使用过yapi等四种产品后做一个简单的对比
# 前提: 需要安装docker. 如果没有安装docker可以见本人 docker 博文
## 1.启动 MongoDB
docker run -d --name mongo-yapi mongo
##2.获取 Yapi 镜像,版本信息可在 阿里云镜像仓库查看
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi
## 3.初始化 Yapi 数据库索引及管理员账号(初始化管理员账号成功,账号名:"admin@admin.com",密码:"ymfe.org")
## 初始化成功后, 会在末尾显示初始化后的账号密码信息
docker run -it --rm \
--link mongo-yapi:mongo \
--entrypoint npm \
--workdir /api/vendors \
registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
run install-server
## 4.启动 Yapi 服务
docker run -d \
--name yapi \
--link mongo-yapi:mongo \
--workdir /api/vendors \
-p 3000:3000 \
registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
server/app.js
## 5.打开阿里云服务器 3000 的端口
如果自己的云服务器的安全组/防火墙设置了禁止额外的端口访问, 需要在安全组/防火墙中放开3000端口
## 6. 登陆
访问 http://ip:3000 登录账号 admin@admin.com,密码 ymfe.org
## 官方使用文档地址:
https://hellosean1025.github.io/yapi/documents/index.html
注意: 项目一开始只能设置成私有, 后面可以在设置中设置成公开 , 这样在运行Yapi所在服务器上面注册的用户可以通过搜索项目名/组名来搜索到这个项目了
满足接口文档用户管理的需求. 添加用户, 并让该用户拥有原有项目的访问和测试权限
在接口一栏找到运行即可
注意: 第一次使用会提示你安装增加插件扩展程序cross-request3.0
如果按提示安装插件过后, 谷歌出现下面警告, 则需要我们另行配置方式如下(cross-request 被官方下架后的插件安装方法 #1603):
直接下载源码:https://github.com/YMFE/cross-request
然后在浏览器的拓展程序中直接选择加载已解压的扩展程序(如果不能下载可通过本博客末尾分享的下载链接下载)