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

相关文章
|
存储 Kubernetes 监控
Docker与Kubernetes集成挑战及方案
面对这些挑战,并不存在一键解决方案。如同搭建灌溉系统需要考虑多种因素,集成Docker与Kubernetes也需要深思熟虑的规划、相当的技术知识和不断的调试。只有这样,才能建立起一个稳定、健康、高效的Docker-Kubernetes生态,让你的应用像花园中的植物一样繁荣生长。
483 63
|
IDE Java 程序员
学生邮箱白嫖/免费安装JetBrains全家桶(IDEA/pycharm等) —— 保姆级教程
本文提供了如何使用学生邮箱免费获取并安装JetBrains全家桶(包括IDEA、PyCharm等)的详细教程,涵盖了学生认证、软件下载、安装及常见问题的解决方法。
8368 0
学生邮箱白嫖/免费安装JetBrains全家桶(IDEA/pycharm等) —— 保姆级教程
|
IDE Java 测试技术
IDEA安装并使用通义灵码
本文介绍了“通义灵码”这一智能编码助手的功能特点,并提供了在IDEA中安装和使用的详细步骤,旨在帮助提升编程效率和代码质量。
IDEA安装并使用通义灵码
|
运维 网络安全 持续交付
IDEA+Docker 远程一键部署项目:技术干货分享
【10月更文挑战第4天】在现代软件开发中,快速、可靠、自动化的部署流程是提升开发效率和运维质量的关键。IDEA(IntelliJ IDEA)作为Java开发者首选的IDE,结合Docker这一轻量级容器化技术,能够实现远程一键部署项目,极大地简化了开发到生产的流程。今天,我将和大家分享这一组合在工作学习中的实际应用和技术干货。
1514 3
|
jenkins 持续交付 开发者
自动化部署:使用Jenkins和Docker实现持续集成与交付
【8月更文挑战第31天】本文旨在为读者揭示如何通过Jenkins和Docker实现自动化部署,从而加速软件开发流程。我们将从基础概念讲起,逐步深入到实际操作,确保即使是初学者也能跟上步伐。文章将提供详细的步骤说明和代码示例,帮助读者理解并应用这些工具来优化他们的工作流程。
|
人工智能 IDE 编译器
idea如何使用AI编程提升效率-在IntelliJ IDEA 中安装 GitHub Copilot 插件的步骤-卓伊凡
idea如何使用AI编程提升效率-在IntelliJ IDEA 中安装 GitHub Copilot 插件的步骤-卓伊凡
3426 15
idea如何使用AI编程提升效率-在IntelliJ IDEA 中安装 GitHub Copilot 插件的步骤-卓伊凡
|
人工智能 自然语言处理 Java
30分钟速成:IntelliJ IDEA 2024下载安装与多语言开发环境配置手册
IntelliJ IDEA是Java/Kotlin开发领域的旗舰级IDE,最新版本实现了AI全栈辅助、量子计算插件和多语言互操作三大技术突破。AI辅助提升代码生成与性能优化准确率40%,量子计算插件支持1024量子位模拟,多语言混合调试性能提升300%。系统要求包括i5以上CPU、8GB内存及Windows 7+等。安装流程涵盖获取Ultimate版、配置启动器及性能优化设置。核心功能包括AI编码助手和多语言开发环境配置。提供量子算法开发和AI代码审查实战案例,并附故障排查指南和学习资源。
|
应用服务中间件 Windows
震惊!idea 2021 社区版手把手安装,超详细过程,新手一看就会 如何安装低版本的IDEA? IDEA安装过程中版本冲突怎么办 idea最新版安装!
本文提供了一个详细的指南,用于安装2021年社区版的IntelliJ IDEA,包括如何处理版本冲突和完成安装过程。
2390 2
震惊!idea 2021 社区版手把手安装,超详细过程,新手一看就会 如何安装低版本的IDEA? IDEA安装过程中版本冲突怎么办 idea最新版安装!
|
存储 测试技术 持续交付
Docker与CI/CD的集成策略及其对软件开发效率和质量的提升作用
本文探讨了Docker与CI/CD的集成策略及其对软件开发效率和质量的提升作用。首先介绍了CI/CD的基本概念,接着阐述了Docker在环境一致性、快速部署、资源隔离和轻量化方面的优势。文章还详细讨论了构建、测试和部署阶段的具体集成方法,以及集成后带来的效率提升、可靠性增强、加速交付和易于管理等好处。最后,通过案例分析展示了集成的实际效果,强调了Docker与CI/CD结合的重要性和未来前景。
423 2
|
Windows
IDEA如何查看已经安装的插件并删除
【10月更文挑战第1天】这段内容主要介绍了如何在IntelliJ IDEA中查看和删除已安装的插件。可以通过软件内的插件市场查看插件列表,包括插件名称、版本号和供应商等信息;也可以通过访问插件目录查看。删除插件则建议在插件市场中进行,包括禁用和卸载步骤,手动删除插件文件夹的方法不推荐,因为可能存在配置残留等问题。
5215 12