Yapi
大约 2 分钟
Yapi是什么
高效、易用、功能强大的API管理平台
旨在为开发、产品、测试人员提供更优雅的接口管理服务.
功能：
帮助开发者轻松创建、发布、维护 API。
自动化生成接口文档。
1、Yapi接口服务搭建
拉取yapi镜像文件
1.docker安装yapi
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi
2.创建数据存储目录
mkdir -p /home/data/yapi/mongodata
3.使用专用mongodata存储yapi数据：
docker run --restart always -v /home/data/yapi/mongodata:/data/db -d --name yapimongo mongo
yapi启动和配置
初始化yapi镜像参数
docker run -it --rm --link yapimongo:mongo --entrypoint npm --workdir /api/vendors registry.cn-hangzhou.aliyuncs.com/anoy/yapi run install-server
启动yapi镜像
使用3001端口进行启动，并跟随docker启动。
docker run -d --restart=always --name yapi --link yapimongo:mongo --workdir /api/vendors -p 3001:3000 registry.cn-hangzhou.aliyuncs.com/anoy/yapi server/app.js
登陆
输入： http:\\ip:3001 进入系统。
2、Yapi接口使用
| 主界面介绍 |
|---|
 |
| 新建项目 |
|---|
 |
| 新建接口 |
|---|
 |
3、IDEA的EasyYapi插件
安装IDEA的EasyYapi插件
| 安装插件 |
|---|
 |
使用方式
打开项目中的包含api/rpc的文件或者在IDEA的左边项目文件区域选择文件或者文件夹, 使用快捷键alt shift E(windows)/ctrl E(mac),
第一次导出需要指定Yapi服务器的地址和项目的token
| 设置Yapi |
|---|
 |
| 导出接口 |
 |
4、接口测试
提示
Chrome浏览器运行接口需要安装 cross-request插件
安装
安装地址cross-request插件
git clone https://github.com/YMFE/cross-request
下载完成后，打开chrome扩展插件，选择上面一步下载的文件目录，安装已解压的插件
运行接口
访问真实的后端服务地址
| 设置运行环境，发送请求 |
|---|
 |
响应的结果
5、成员管理
