请求前处理脚本,会在接口请求开始前执行,请求后处理脚本,会在请求完成后执行 5.4 token配置 生成唯一项目标识,可以作为请求yapi项目openapi的凭证 非可视化界面操作,yapi提供了部分常用的 定期进行接口同步,进行数据导入等等 5.5 全局mock脚本--未研究 5.6 生成ts services 未研究 5.7 swagger自动同步 可以选择时间,选择周期,选择同步方式,定期自动执行接口同步,保证yapi
所以需要有一个高效,易用的管理平台,比如Yapi 首先安装,官网部署链接: 官方部署Yapi地址 在按照教程进行安装后发现有些问题,就是这里面没有node和mongo的安装教程。 nvm install 12.14 //这里我选择了12.4 然后启动: yapi server 根据提示,切换到部署目录,输入: “node vendors/server/app.js” 指令启动服务器
本文主要讲四个部分:1.什么是Yapi2.Centos7 下基于docker安装Yapi3.Yapi数据迁移4.利用Nginx反向代理什么是YapiYApi 是高效、易用、功能强大的 api 管理平台, : admin@admin.com密码: ymfe.org至此,Yapi基于docker环境安装完成,就可以使用了还需要把旧的服务器数据迁移到这个yapi中。 将旧的Yapi项目导入到新的Yapi中由于旧的服务器快到期了,需要将旧的Yapi的数据导入到新的Yapi中。 进入docker环境中:# docker exec -it yapi-mongodb /bin/bash将远程的mongodb导入到新的yapi中。 /yapi4.验证数据是否都导入正确。
mongod:mongod /var/lib/mongo chown -R mongod:mongod /var/log/mongodb chown mongod:mongod /tmp/*.sock yapi 安装配置 wget https://github.com/YMFE/yapi/archive/refs/tags/v1.9.3.tar.gz tar -zxvf v1.9.3.tar.gz mv yapi -1.9.3 yapi cd yapi cp config_example.json config.json 把默认的数据库链接配置干掉 vi config.json db:{ - user: registry.npm.taobao.org # 初始化数据库 npm run install-server # 启动 node server/app.js #or pm2 start server/app.js --name yapi closeRegister":true } 外网部署之后 1.9.2 以下版本有上传 提权漏洞,应该干掉注册 nginx 安装配置 yum install nginx vi /etc/nginx/conf.d/yapi.conf
,准备以后转战 YApi 了,我把 YApi 部署到我自己的服务器上,以后就用它了。 Yapi 安装部署 2.1 本地部署 首先安装官方提供的 yapi-cli 工具,顺带安上 pm2 回头启服务的时候可以用来守护和管理进程: npm install -g yapi-cli pm2 -- registry https://registry.npm.taobao.org yapi server 然后进行可视化配置,我是下面这样配置的: image.png 点击「开始部署」,就开始 Yapi /usr/share/my-yapi/vendors/server/app.js -n yapi --max-memory-restart 500M pm2 stop yapi # pm2 后面的使用,可以参考官方文档: YApi-教程 但要提一句的是,我在将 swagger2.0 的接口文档导入 Yapi 的时候,发现出现了一点问题 ?
1.启动 MongoDB # docker run -d --name mongo-yapi mongo 2.获取yapi镜像 # docker pull registry.cn-hangzhou.aliyuncs.com /anoy/yapi 3.初始化数据库索引及管理员账号 # 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 登录账号 admin@admin.com,密码 ymfe.org 6.其他命令 #启动停止 # docker stop yapi # docker start yapi # 开机自启动 # chmod
先说一下为什么要使用Docker安装Yapi 方便管理 yapi安装对nodejs和npm的版本要求,非常容易安装失败(这是主要原因) 拉镜像 docker pull registry.cn-hangzhou.aliyuncs.com /anoy/yapi 创建挂载目录 mkdir -p /data/yapi/mongodata 运行专用mongo 服务名设为yapimongo docker run --restart always npm --workdir /api/vendors registry.cn-hangzhou.aliyuncs.com/anoy/yapi run install-server 初始化管理员账号成功 ,账号名:"admin@admin.com",密码:"ymfe.org" 运行服务 这里内外端口号都用3000 docker run -d --restart=always --name yapi -- ", "port": 27017 } } 保存后退出:exit 重启服务:docker restart yapi 注册 禁用注册后怎么添加用户呢,登录yapi,然后添加一个项目,增加一个注册用户接口
参考https://www.jianshu.com/p/a97d2efb23c5 1、启动 MongoDB docker run -d --name mongo-yapi mongo 2、获取 Yapi 4、启动 Yapi 服务 docker run -d \ --name yapi \ --link mongo-yapi:mongo \ --workdir /api/vendors \ 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 server/app.js 六手动搭建YAPI镜像 1、下载 YAPI 到本地 wget -o yapi.tar.gz https://github.com/YMFE/yapi/archive/v1.8.0
yapi项目 https://github.com/YMFE/yapi/tags 镜像 https://hub.docker.com/r/jayfong/yapi 创建资源清单 vim yapi.yaml namespace: yapi labels: app: yapi spec: ports: - port: targetPort: name: yapi # nodePort: 32368 # type: NodePort type: ClusterIP selector: app: yapi --- apiVersion : apps/v1 kind: Deployment metadata: name: yapi namespace: yapi labels: app: yapi spec: replicas : - name: yapi image: harbor.myit.icu/yapi/yapi:latest imagePullPolicy: IfNotPresent
可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。YApi 特性它都有哪些特性呢? Yapi 文档点击 开始部署 后,会出现密码和用户名。 可以记起来本地运行 YApi进到 Yapi-cli目录,运行这个时候浏览器的 3000 端口会运行 YApi 文档跨域插件如果想要在浏览器 YApi 访问到本地接口,需要安装 Yapi 提供的谷歌插件~ 导出导入YApi 也支持导入导出数据,便于项目跨平台迁移知识扩展:了解更多关于 YApi 的使用技巧! YApi Mock服务的使用教程 使用YApi实现接口自动化测试的技巧与方法
Yapi是一个高效、易用、功能强大的接口文档管理工具,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API. mongo 2、获取 Yapi 镜像,版本信息可在 阿里云镜像仓库 查看 docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi 3、初始化 Yapi 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、使用 Yapi 访问 http://localhost:3000 登录账号 admin@admin.com,密码 ymfe.org
cd docker-yapi docker-compose up 方法二 git clone https://gitee.com/fjc0k/docker-YApi.git cd docker-YApi / # 修改 docker-compose.yml 中 yapi-web 下的环境变量 YAPI_ADMIN_ACCOUNT 为你的管理员邮箱,YAPI_ADMIN_PASSWORD 为你的管理员密码 [root@yapi docker-YApi]# vim docker-compose.yml - YAPI_ADMIN_ACCOUNT=18621048481@163.com | 数据库配置 环境变量名称 类型 说明 示例 YAPI_DB_SERVERNAME string MongoDB 服务地址 yapi-mongo YAPI_DB_PORT number YAPI_MAIL_HOST string 邮件服务地址 smtp.163.com YAPI_MAIL_PORT number 邮件服务端口 465 YAPI_MAIL_FROM string
0x01 简述 Yapi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。 影响版本 Yapi <= 1.9.2 漏洞影响面 通过ZoomEye网络空间搜索引擎,搜索ZoomEye dork数据挖掘语法查看漏洞公网资产影响面。 zoomeye dork 关键词:app:"YApi 可视化接口管理平台" https://www.zoomeye.org/searchResult? 通过修改 Yapi 项目目录下的 config.json 文件,将 closeRegister 字段修改为 true 并重启服务即可。 3、如果没有 Mock 功能的需求,建议关闭 Yapi 的 Mock 功能。
YApi官网:https://hellosean1025.github.io/yapi/ 安装 nodejs 和 Yapi yum install wget cd /root wget https:/ https://registry.npm.taobao.org ln -s /usr/local/nodejs/bin/pm2 /usr/bin/ ln -s /usr/local/nodejs/bin/yapi /usr/bin/ ln -s /usr/local/nodejs/bin/yapi-cli /usr/bin/ 安装MongoDB wget https://fastdl.mongodb.org/linux yapi server # 访问 http://127.0.0.1:9090 ,根据页面配置 # 看到页面配置成功后可以 ctrl + c 停止本进程 启动服务 # 如果 mongod 已运行, 本条命令可以跳过 mongod --config /usr/local/mongodb/mongodb.conf # pm2 启动 cd /usr/local/mongodb/my-yapi pm2
# 背景 作为前文接口管理平台Yapi-最佳实践 (opens new window)的补充,本文将给出Yapi私有化部署方案的教程 开源代码地址https://github.com/benym/yapi-deploy (opens new window) 文件取自yapi-1.9.3开源版本 # 部署方式 # 可视化部署 使用官方提供的yapi-cli工具,部署 YApi平台是非常容易的。 npm install -g yapi-cli --registry https://registry.npm.taobao.org yapi server # 虚拟机部署 下载本文的yapi-deploy /bin/sh # yapi初始化后会有一个init.lock文件 lockPath="/yapi-virtual/init.lock" # 进入yapi项目,如部署机器不同,请修改该路径 cd / nohup等后台运行形式,yapi将在用户退出shell界面时同时停止运行 # Docker部署 下载本文的yapi-deploy项目 拷贝yapi-deploy(文件内包含yapi-virtual)文件夹到宿主机
1、关于yapi 上节我们说了关于代理转发、跨域啊这么一些问题,对于数据的伪造我们使用了yapi,因为这样的话既可以很好的维护一封api文档,又可以进行数据的mock,这是我们这个项目的的接口文档:vue-mall yapi就是一个接口管理平台了,顺带做些数据mock。 2、简单使用 怎么用看yapi文档,官方文档还是讲的比较清晰的,我这里就以项目中使用了的来举几个列子。 登录注册一个账号以后,你可以创建一些分类,对接口分门别类,这样的话就比较清晰,也利于维护。 ? 新建接口 3、高级mock 一般我不用普通mock来进行编写,因为太繁琐了,还要一个个去输入框里输入,所以基本项我们panda-mall项目中在yapi上的mock都是使用的高级mock功能。 高级mock 4、小结 就是这么简单,mockJson就是定义的我们请求返回的数据,看看官网的yapi高级mock的教程。
{ role: "dbAdmin", db: "yapi" }, { role: "readWrite", db: "yapi" } ] }); 构建YAPI镜像 我们将基于node 首先要构建Yapi镜像。 下载源码: wget -O yapi.tgz http://registry.npm.taobao.org/yapi-vendor/download/yapi-vendor-$1.tgz 其中$1是版本 yapi . : docker kill yapi && docker rm yapi && docker run -d -p 3001:3001 --name yapi --net tools-net --ip
"adminAccount": "598941324@qq.com", "db": { "servername": "127.0.0.1", "DATABASE": "yapi wenyang,DC=com", "searchStandard": "uid", "usernameKey": "displayName" } } ---- 标题:yapi
YApi官网:https://hellosean1025.github.io/yapi/ 安装 nodejs 和 Yapi yum install wget cd /root wget https:/ /usr/bin/ ln -s /usr/local/nodejs/bin/yapi-cli /usr/bin/ 安装MongoDB wget https://fastdl.mongodb.org/linux yapi server # 访问 http://127.0.0.1:9090 ,根据页面配置 # 看到页面配置成功后可以 ctrl + c 停止本进程 启动服务 # 如果 mongod 已运行, 本条命令可以跳过 mongod --config /usr/local/mongodb/mongodb.conf # pm2 启动 cd /usr/local/mongodb/my-yapi pm2 start "vendors/server/app.js" --name yapi # 访问 http://127.0.0.1:3000,这个端口看初始化的时候配置是哪个就用哪个
模板与占位符 3.1 占位符 关于占位符,可以参看《yapi中使用json-schema mock数据》中的"3. 基于mockjs占位符的mock"。