YApi 可视化接口管理平台
https://github.com/YMFE/yapi Yapi源码
YApi
YApi是由去哪儿网移动架构组(简称YMFE，一群由FE、iOS和Android工程师共同组成的最具想象力、创造力和影响力的大前端团队)开源的可视化接口管理工具，一个可本地部署的、打通前后端及QA的接口管理平台，YApi旨在为开发、产品和测试人员提供更优雅的接口管理服务，可以帮助开发者轻松创建、发布和维护不同项目，不同平台的API。有了YApi，我们可以很方便的测试、管理和维护多个项目的API接口，不像Swagger那样是随应用生和灭的(且线上环境下大多数须关闭)，YApi是一个独立的服务平台。
一、安装（docker方式安装）
前言介绍
- Yapi 由 YMFE 开源，旨在为开发、产品、测试人员提供更优雅的接口管理服务，可以帮助开发者轻松创建、发布、维护 API。
权限管理
- YApi 成熟的团队管理扁平化项目权限配置满足各类企业的需求
可视化接口管理
- 基于 websocket 的多人协作接口编辑功能和类 postman 测试工具，让多人协作成倍提升开发效率
Mock Server
- 易用的 Mock Server，再也不用担心 mock 数据的生成了
自动化测试
- 完善的接口自动化测试,保证数据的正确性
数据导入
- 支持导入 swagger, postman, har 数据格式，方便迁移旧项目
插件机制
- 强大的插件机制，满足各类业务需求
- 去哪儿网移动架构组（YMFE）是由FE，iOS和Android工程师共同组成的，去哪儿最具想象力、创造力和影响力的大前端团队。
使用 Docker 构建 Yapi
1、创建 MongoDB 数据卷
- docker volume create mongo_data_yapi
2、启动 MongoDB
- docker run -d --name mongo-yapi -v mongo_data_yapi:/data/db mongo
3、获取 Yapi 镜像，版本信息可在 阿里云镜像仓库 查看
- docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi
4、初始化 Yapi 数据库索引及管理员账号（一行一行输入， 为换行符）
- docker run -it --rm \
- --link mongo-yapi:mongo \
- --entrypoint npm \
- --workdir /api/vendors \
- [registry.cn-hangzhou.aliyuncs.com/anoy/yapi](http://registry.cn-hangzhou.aliyuncs.com/anoy/yapi)\
- run install-server- 自定义配置文件挂载到目录 /api/config.json，官方自定义配置文件 (
https://github.com/YMFE/yapi/blob/master/config_example.json?spm=5176.1972344.1.6.LYdCBe&file=config_example.json
自定义配置文件挂载到目录 /api/config.json
放到MongoDB容器镜像里面
mkdir /api
vim config.json
{
"port": "3000",
"adminAccount": "admin@admin.com",
"timeout":120000,
"db": {
"servername": "127.0.0.1",
"DATABASE": "yapi",
"port": 27017,
"user": "mindoneyapi",
"pass": "12345678",
"authSource": ""
},
"mail": {
"enable": true,
"host": "smtp.163.com",
"port": 465,
"from": "***@163.com",
"auth": {
"user": "***@163.com",
"pass": "*****"
}
}
}5、启动 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.js6、使用 Yapi
- 访问 http://localhost:3000 登录账号 admin@admin.com，密码 ymfe.org
Yapi 官方文档
其他相关操作
关闭 Yapi
- docker stop yapi
启动 Yapi
- docker start yapi
升级 Yapi
- 1、停止并删除旧版容器docker rm -f yapi
- 2、获取最新镜像docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi
- 3、启动新容器
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二、使用dockerfile的安装方式
▶ 手动构建 yapi 镜像
1、下载 YAPI 到本地
wget -o yapi.tar.gz https://github.com/YMFE/yapi/archive/v1.8.0.tar.gz下载地址：https://github.com/YMFE/yapi/releases
2、编辑 Dockerfile
FROM node:12-alpine as builder
RUN apk add --no-cache git python make openssl tar gcc
COPY yapi.tar.gz /home
RUN cd /home && tar zxvf yapi.tar.gz && mkdir /api && mv /home/yapi-1.8.0 /api/vendors
RUN cd /api/vendors && \
npm install --production --registry https://registry.npm.taobao.org
FROM node:12-alpine
MAINTAINER 545544032@qq.com
ENV TZ="Asia/Shanghai" HOME="/"
WORKDIR ${HOME}
COPY --from=builder /api/vendors /api/vendors
COPY config.json /api/
EXPOSE 3000
ENTRYPOINT ["node"]3、构建镜像
docker build -t yapi .作者：运维老许
联系方式：strive120620@163.com
微信公众号：Linux必修之路
声明1：本站部分资源收集自互联网，仅供个人学习交流，如不慎侵犯了您的权益，请联系我，我将尽快处理！
声明2：本文版权归作者，欢迎转载，但未经作者同意必须在文章页面给出原文链接，否则保留追究法律责任的权利！
