正文

docker搭建yapi接口文档系统idea中上传接口在线调用(代码片段)

author  author  2022-12-04  423

关键词：

一、前言

在我们后端开发中，必不可少的是接口的交接，有很多种方式，常见的就是swagger，不过这个侵入性太强了。还有就是接口文档的框架，比如今天小编带大家一起搭建的yapi，在公司还是挺常见的！今天小编就大家从搭建到使用，详细的教学一波哈！！

二、介绍

1. 平台介绍

YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

2. 特性

基于 Json5 和 Mockjs 定义接口返回数据的结构和文档，效率提升多倍
扁平化权限设计，即保证了大型企业级项目的管理，又保证了易用性
类似 postman 的接口调试
自动化测试, 支持对 Response 断言
MockServer 除支持普通的随机 mock 外，还增加了 Mock 期望功能，根据设置的请求过滤规则，返回- - 期望数据
支持 postman, har, swagger 数据导入
免费开源，内网部署，信息再也不怕泄露了

3. 环境支持

nodejs（7.6+)
mongodb（2.6+）
git

在docker中只需要搭建一下mongo，用来数据的存储即可！

三、运行mongo

0. 创建网络

docker network create yapi

1. 创建挂载文件

mkdir -p /data/mongo

2. 运行mongo

docker run -d \\
  --name mongodb \\
  --restart always \\
  --net=yapi \\
  -p 27017:27017 \\
  -v /data/mongo:/data/db \\
  -e MONGO_INITDB_DATABASE=yapi \\
  -e MONGO_INITDB_ROOT_USERNAME=yapi \\
  -e MONGO_INITDB_ROOT_PASSWORD=yapi \\
  mongo

3. 进入容器初始化数据库

进入 MongoDB 容器，从上图查看 MongoDB 容器可以获取到容器 id，以下示例使用 50f1f6c50139代表 MongoDB 的容器 id，只需要简写即可！

docker exec -it 50 /bin/bash

接着输入：

mongosh

==新版本需要加上sh，不然无法进入！==

use admin;
db.auth("yapi", "yapi");
# 创建 yapi 数据库
use yapi;
# 创建给 yapi 使用的账号和密码，限制权限
db.createUser(
  user: yapi,
  pwd: yapi,
  roles: [
  role: "dbAdmin", db: "yapi" ,
  role: "readWrite", db: "yapi" 
  ]
);
# 退出 Mongo Cli
exit
# 退出容器
Ctrl+P+Q

四、运行yapi

1. 搭建挂载配置文件

mkdir -p /data/yapi

vim config.json


   "port": "3000",
   "adminAccount": "wangzhenjun1221@163.com",
   "timeout":120000,
   "db": 
     "servername": "mongo",
     "DATABASE": "yapi",
     "port": 27017,
     "user": "yapi",
     "pass": "yapi",
     "authSource": ""
   ,
   "mail": 
     "enable": true,
     "host": "smtp.gmail.com",
     "port": 465,
     "from": "*",
     "auth": 
       "user": "wangzhenjun1221@163.com",
       "pass": "xxx"

:wq退出

2. 初始化数据库表

docker run -d --rm \\
  --name yapi-init \\
  --link mongodb:mongo \\
  --net=yapi \\
  -v /data/yapi/config.json:/yapi/config.json \\
   yapipro/yapi \\
  server/install.js

3. 测试连接mongo

我们使用Navicat进行可视化的连接数据库输入：admin 用户名密码都是刚刚配置的：yapi

连接成功！！

4. 运行yapi

docker run -d \\
   --name yapi \\
   --link mongodb:mongo \\
   --restart always \\
   --net=yapi \\
   -p 3000:3000 \\
   -v /data/yapi/config.json:/yapi/config.json \\
   yapipro/yapi \\
   server/app.js

5. 测试使用

ip:3000 http://192.168.84.144:3000/

初始化管理员账号在上面的 config.json 配置中adminAccount 初始化密码就是：yapi.pro

6. 新建项目

7. 获取token

五、Idea中使用

1. 下载插件

插件名称：EasyYapi

2. 配置插件

3. 测试上传

找到controller

选择你要上传的接口，点击对号上传！

填写token

上传成功：

六、在线请求使用

1. 配置地址

2. 配置地址

3. 安装cross-request 插件

发送请求时，会提醒你安装，你按照提示安装下载即可！

也可以下载小编的：

直接解压，拖拽到这里就行！！

4. 点击发送

测试完成！！

七、总结

总的来说搭建还是比较简单，集成和使用也挺好用！非常推荐哈！！

小编辛辛苦苦写了半天，看到这里还不给小编点个关注！！谢谢大家

<hr> 有缘人才可以看得到的哦！！！欢迎大家关注小编的微信公众号，谢谢大家！！

点击访问！小编自己的网站，里面也是有很多好的文章哦！

docker实践--搭建yapi测试平台

现状：一台机器安装多套环境，虚拟机太繁琐解决方案：通过Docker模拟安装测环境参考：https://blog.csdn.net/qq_32447301/article/details/81394024使用Docker构建Yapi1.创建MongoDB数据卷dockervolumecreatemongo_data_yapi2.启动MongoDBdockerrun-d--namemongo-yapi 查看详情

为了不写接口文档，我肝了个idea插件！

写什么接口文档，快来看看这个IDEA插件，一键生成Markdown文档，直接上传YApi！前言写代码的快乐，在于通过一顿猛如虎的操作，实现了自己设计的逻辑流程。（也可能并不是很快乐！）这时候，你以为就可以关机么？还有接口... 查看详情

使用yapi工具编辑接口文档

相对于swagger来说，yapi页面更加美观，使用上功能也更多了一些，所以操作也相对复杂，上文安装完yapi后，本文将介绍如何使用yapi。1.建立文档地址1.新建分组在多组同时使用时，可以按照小组对文档进... 查看详情

yapi:从0搭建api文档管理工具

...持表格、代码块等。最近看到一篇文章在说YAPI，就准备搭建一个试试效果如何。YAPI是去哪儿网开源的一款API管理工具，理念如下：特性：选择YAPI试试手的原因是因为我看到了它支持MockServer，这样前端开发同学就不用等待后端... 查看详情

告别swagger单一页面，接口文档yapi工具安装(代码片段)

一.安装gityum-yinstallgitgit--version二.安装mongodb三.安装node.js可以参考但是注意版本过高也会出现警告四.安装yapi这里楼主使用的是下载后执行安装（原因是可视化部署时报错较多）mkdiryapicdyapigitclonehttps://github.com/YMFE/y... 查看详情

告别swagger单一页面，接口文档yapi工具安装(代码片段)

yapi一个神奇的接口管理平台(代码片段)

前言：API接口在设计时往往需要编写大量的文档，而且编写完成后往往需要根据实际情况经常改动文档，这使得文档编写维护工作量相对较大，让很多的开发者都很头疼。1.为什么要使用接口管理平台接口版本迭... 查看详情

开发工具：chrome安装yapi扩展教程

我是ABin-阿斌：写一生代码，创一世佳话，筑一览芳华。如果小伙伴们觉得不错就一键三连吧~上一篇：IDEA：Idea集成EasyYApi插件实现接口文档的生成与更新下一篇：chrome安装yapi扩展教程查看详情

开发工具：chrome安装yapi扩展教程

基于docker搭建jumpserver堡垒机操作实践(代码片段)

一、背景笔者最近想起此前公司使用过的堡垒机系统，觉得用的很方便，而现在的公司并没有搭建此类系统，想着以后说不定可以用上；而且最近也有点时间，因此来了搭建堡垒机系统的兴趣，在搭建过程中参考了比较多的文档... 查看详情

docker折腾记:构建yapi容器,从构建发布到可用(代码片段)

...建的思路,优化,实现的姿势,感兴趣的小伙伴往下走~~~yapi(DockerHub):crper/yapiGithub地址:yapi-docker效果图登录登录成功项目区域yapi容器已经内置了bash为默查看详情

使用插件快速完成yapi文档(代码片段)

...，选择导出MD文件选择文件的存放路径就能得到一个md接口文档如果需要生成到yapi上就选择会让输入一次token，将刚才得token粘贴一次就行了控制台打印成功，点击超链接即可快速传送这个方式会少了json格式，所以... 查看详情

使用插件快速完成yapi文档(代码片段)

开发常用的优质开源项目(代码片段)

...理工具，功能强大，可以轻松的自己部署。而且支持使用docker部署，使用成本很低了。使用docker部署可以参考这篇文章：https://www.jianshu.com/p/a97d2efb23c5Rap2官网：https://github.com/thx/rap2-delosRap2是由阿里妈妈前端团队开源的一款接口... 查看详情

api接口管理工具推荐

...理工具，功能强大，可以轻松的自己部署。而且支持使用docker部署，使用成本很低了。使用docker部署可以参考这篇文章：https://www.jianshu.com/p/a97d2efb23c52.Rap2https://github.com/thx/rap2-delosRap2是由阿里妈妈前端团队开源的一款接口管理工... 查看详情

centos上用docker方式安装yapi(代码片段)

假设你的Linux系统上已经有docker了。1、创建目录mkdir-p/data/mongo/datamkdir-p/data/mongo/config2、启动mongdbdockerrun-d--namemongo-yapi--restart=always-p27017:27017-v/data/mongo/data:/data/db-eMONGO_INITDB_ROOT_USERNA 查看详情

centos上用docker方式安装yapi(代码片段)

可视化接口管理平台yapi，让你轻松搞定api的管理问题(代码片段)

...文档会接踵而来，比如：需求文档、架构文档、接口文档等等，我们通过SVN、Git等可以很方便的管理，面对需求的不断变化，我们需要不断的对各类文档进行维护。但在开发阶段，针对接口文档而言，... 查看详情