Docker安装Yapi并集成IDEA上传接口到Yapi

Docker安装Yapi并集成IDEA上传接口到Yapi

Yapi是一个优雅切高效的接口管理服务，给后端开发提供更方便的api管理，给前端开发提供更方便的接口mock调试，给测试人员提供更轻便的接口测试和自动化测试环境，也可以自动生成各种接口文档，也支持导入json、swagger、json格式的接口，可以配置不同环境调用接口，满足研发过程中需要的基础的接口管理及应用场景，非常好用~（由于项目中有使用，故此记录）

Docker安装Yapi

Yapi的依赖环境非常简单，依赖环境版本如下：

• nodejs（7.6+)
• mongodb（2.6+）

由于GitHub上面的仓库下载比较复杂，所以我们使用阿里云的镜像，自带node，我们只需要再安装一个mongodb就可以了，直接运行起来

docker run -d --name mongo-yapi mongo

获取Yapi镜像

docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi

初始化Yapi数据库索引及管理员账号

	docker run -it --rm \
	--link mongo-yapi:mongo \
	--entrypoint npm \
	--workdir /api/vendors \
	registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
	run install-server

启动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

访问Yapi，访问 ip:3000 使用默认的账号密码登录，账号 admin@admin.com，密码 ymfe.org，就可以创建项目，上传接口了

IDEA集成YapiUpLoad

1. 登陆后我们会进入个人空间，首先先新建一个项目填写基本信息就可以了
   

2. 进入项目我们需要在项目设置里面保存几个参数，后面会在idea配置中使用

   # 项目id：设置的页面链接中间的数字
   # 项目token：每个项目的token不一样
   # Yapi的URL：我们上面设置的ip:3000 ，也可以设置host访问
   

3. 在项目IDEA中打开file>>Settings>>Plugins中查找YapiUpload下载，我记得是需要重启IDEA的
4. IDEA配置文件，找到这个misc.xml文件，添加以下内容

  projectType字段根据你要上传的接口类型决定，如果为dubbo 接口就填dubbo ，如果是api 接口就填api
  attachUploadUrl 填写方式:上传java 类zip 的url,如果要用请实现http://localhost/fileupload 接口 接口请求参数为 file 文件类型。(可不填)

  <component name="yapi">
    <option name="projectToken">token</option>
    <option name="projectId">11</option>
    <option name="yapiUrl">http://127.0.0.1:3000</option>
    <option name="projectType">api</option>
    <option name="attachUploadUrl">http://127.0.0.1:3000/fileupload</option>
  </component>

5. 上传接口到Yapi

   

6. 上传之后就可以在yapi中进行接口管理和调试了

个人推荐Yapi的原因是因为操作各方面都比较简单，容易上手，虽然复杂的业务场景测试实现比较麻烦，但是基础的接口测试十分方便快捷，可视化界面也十分友好，有兴趣的朋友可以试一下，推荐给你团队吧！

docker安装参考：
Docker安装Yapi
官方以及git上的参考资料：
内网部署Yapi
快速使用YapiIdeaUploadPlugin