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

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

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. 登陆后我们会进入个人空间,首先先新建一个项目填写基本信息就可以了

在这里插入图片描述

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

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

在这里插入图片描述

  1. 在项目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>
  1. 上传接口到Yapi

    在这里插入图片描述

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

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

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

相关文章
|
2月前
|
IDE Java 测试技术
IDEA安装并使用通义灵码
本文介绍了“通义灵码”这一智能编码助手的功能特点,并提供了在IDEA中安装和使用的详细步骤,旨在帮助提升编程效率和代码质量。
IDEA安装并使用通义灵码
|
1月前
|
运维 网络安全 持续交付
IDEA+Docker 远程一键部署项目:技术干货分享
【10月更文挑战第4天】在现代软件开发中,快速、可靠、自动化的部署流程是提升开发效率和运维质量的关键。IDEA(IntelliJ IDEA)作为Java开发者首选的IDE,结合Docker这一轻量级容器化技术,能够实现远程一键部署项目,极大地简化了开发到生产的流程。今天,我将和大家分享这一组合在工作学习中的实际应用和技术干货。
219 3
|
1月前
|
IDE Java 程序员
学生邮箱白嫖/免费安装JetBrains全家桶(IDEA/pycharm等) —— 保姆级教程
本文提供了如何使用学生邮箱免费获取并安装JetBrains全家桶(包括IDEA、PyCharm等)的详细教程,涵盖了学生认证、软件下载、安装及常见问题的解决方法。
420 0
学生邮箱白嫖/免费安装JetBrains全家桶(IDEA/pycharm等) —— 保姆级教程
|
3月前
|
Kubernetes Devops 持续交付
DevOps实践:使用Docker和Kubernetes实现持续集成和部署网络安全的守护盾:加密技术与安全意识的重要性
【8月更文挑战第27天】本文将引导读者理解并应用DevOps的核心理念,通过Docker和Kubernetes的实战案例,深入探讨如何在现代软件开发中实现自动化的持续集成和部署。文章不仅提供理论知识,还结合真实示例,旨在帮助开发者提升效率,优化工作流程。
|
1月前
|
应用服务中间件 Windows
震惊!idea 2021 社区版手把手安装,超详细过程,新手一看就会 如何安装低版本的IDEA? IDEA安装过程中版本冲突怎么办 idea最新版安装!
本文提供了一个详细的指南,用于安装2021年社区版的IntelliJ IDEA,包括如何处理版本冲突和完成安装过程。
328 2
震惊!idea 2021 社区版手把手安装,超详细过程,新手一看就会 如何安装低版本的IDEA? IDEA安装过程中版本冲突怎么办 idea最新版安装!
|
1月前
|
Windows
IDEA如何查看已经安装的插件并删除
【10月更文挑战第1天】这段内容主要介绍了如何在IntelliJ IDEA中查看和删除已安装的插件。可以通过软件内的插件市场查看插件列表,包括插件名称、版本号和供应商等信息;也可以通过访问插件目录查看。删除插件则建议在插件市场中进行,包括禁用和卸载步骤,手动删除插件文件夹的方法不推荐,因为可能存在配置残留等问题。
501 11
|
1月前
|
Oracle IDE Java
IDEA安装教程配置java环境(超详细)
IDEA安装教程配置java环境(超详细)
|
3月前
|
Java
2022年最新最详细的IntelliJ idea高效插件的介绍安装,让你的工作效率提升10倍
这篇文章详细介绍了10款IntelliJ IDEA的高效插件,包括Codota代码智能提示、Key Promoter X快捷键提示、CodeGlance代码缩略图、Lombok代码简化、阿里巴巴代码规范检查、SonarLint代码质量检查、Save Actions格式化代码、Translation翻译、Rainbow Brackets彩虹括号和Nyan Progress Bar彩虹进度条插件,旨在帮助提升开发效率和代码质量。
2022年最新最详细的IntelliJ idea高效插件的介绍安装,让你的工作效率提升10倍
|
3月前
|
前端开发 Java Maven
【前端学java】全网最详细的maven安装与IDEA集成教程!
【8月更文挑战第12天】全网最详细的maven安装与IDEA集成教程!
98 2
【前端学java】全网最详细的maven安装与IDEA集成教程!
|
3月前
|
Kubernetes NoSQL MongoDB
k8s安装YAPI
k8s安装YAPI