yapi的安装和配置

转载来源:第20关 yapi的安装和配置_yapi默认密码-CSDN博客
第20关 yapi的安装和配置

20-3 yapi的安装和配置

基于docker一键部署yapi的一个开源的项目:【秀的雅痞】
https://github.com/Ryan-Miao/docker-yapi
官方github仓库地址:
https://github.com/YMFE/yapi

文档写的非常详细,我们要做的就是根据文档里面的步骤一步一步地来配置。

但是,有一些关键的地方,有的人可能容易出错,我这里边也做了一个截图,大家根据文档里面的一系列配置之后,一步一步的往下走,就能够看到我这里面的截图了。【简单,听话,照做,信心】

首先,我们来根据文档里面直接配置。

这里面告诉了我们,首先我们要做的事就是初始化db, 开启自定义配置,用了3条代码指令来完成。

docker-compose.yml可以将我们多个docker的配置集中到一个配置文件,集成运行。
访问 https://github.com/Ryan-Miao/docker-yapi
愉快地CV大法。
在这里插入图片描述
在这里插入图片描述
第一次使用,绝对会遇到这个问题:
在这里插入图片描述
解决方法如下:
在这里插入图片描述
作如下操作:

/*
1.去掉#号 command: "yapi server",
2.给命令 command: "node /my-yapi/vendors/server/app.js" 前面加#号
*/

然后就是这样的:
在这里插入图片描述
接着:
在这里插入图片描述

问题就解决了。
下一步就是查看你本地主机的ip地址:
在终端输入ifconfig
在这里插入图片描述
然后浏览器访问192.168.0.123:9090,会来到以下页面:
在这里插入图片描述
公司名称:随便写,比如是mxshop,
部署路径:不用改,采用默认的,
管理员邮箱:不用改,也可以改成你自己的邮箱
网站端口号:不用改,采用默认的,
数据库地址:把127.0.0.1改成mongo
数据库端口:不用改,采用默认的,
数据库名:不用改,采用默认的,
数据库认证:点击一下,打开按钮,
在这里插入图片描述
用户名就是:yapi
密码就是:yapi123456

在这里插入图片描述

然后点击部署:【喝杯白开水的功夫就部署好了】
在这里插入图片描述

然后再做如下的图片所示的操作。
在有这个效果的前置条件下执行以下操作:
在这里插入图片描述

输入如下信息:
账号名:admin@admin.com
密码:ymfe.org

先执行docker-compose down
再执行docker-compose up -d
我截图截得不完整。

然后在浏览器中输入 http://ip地址:3000
在这里插入图片描述
此时就是部署完成了。

如何使用yapi? 进入下一小节。

20-4 yapi基本功能使用

一图胜千言:
在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

20-5 接口的导入和导出

在这里插入图片描述

20-6 docker更新、重启导致部署的服务清空

此时需要重新部署服务,虽然有些命令记录在文档中,但仍然提高不了干活效率。
想出以下办法:
1.docker-compose.yml
该文件作用是集中部署docker相关的服务
对于数据库/数据相关的操作,一定要记住这么做:

    volumes:
      - ./volumes/fastemsp_db:/var/lib/mysql

2.项目管理:命令复用.md
该文件中作用是记录用到的所有命令,方便以后复制粘贴。
3.项目管理:过程文档输出.md
该文件的作用是记录项目实现的过程,重点记录功能点+实现步骤+官网链接+截图
4.博客输出

关于docker的数据持久化的正确了解之docker-compose的volumes:
参考链接:https://www.dazhuanlan.com/taku/topics/1022543
讲的很好:是什么 + 解决了什么问题 + 代码案例
怕失效故截关键的图:
在这里插入图片描述
也就是说docker-compose 容器数据持久化,像下面这么做就对了:
【除了会配置,还得懂这么配置的原因是为了解决啥问题】

    volumes:
      - ./volumes/fastemsp_db:/var/lib/mysql

多说一点:

    depends_on:
      - mysql

有了这个配置,就不用管容器依赖的启动顺序的问题。

20-7. yapi 测试集合

如果接口数量成百上千,一个个手动测试是很要命的,所以这时候可以用 yapi 中的测试集合来帮助我们完成测试,
一图胜万言:
在这里插入图片描述

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
你可以按照以下步骤在 Docker 中安装 Yapi: 1. 首先,确保已经安装了 Docker 和 Docker Compose。你可以参考 Docker 官方文档来安装它们。 2. 创建一个文件夹来存放 Yapi配置和数据文件。你可以使用以下命令创建文件夹: ``` mkdir yapi ``` 3. 进入 yapi 文件夹,并在其中创建一个名为 `docker-compose.yml` 的文件,内容如下: ```yaml version: "3" services: yapi: image: helight/yapi restart: always ports: - 3000:3000 volumes: - ./config.json:/yapi/vendors/config.json - ./data:/yapi/vendors/data ``` 4. 在 yapi 文件夹中创建一个名为 `config.json` 的文件,用于配置 Yapi。你可以根据需要进行配置,以下是一个示例配置的基本结构: ```json { "port": "3000", "db": { "servername": "mongo", "DATABASE": "yapi", "port": 27017, "user": "root", "pass": "ymfe.org" }, "mail": { "enable": false, "host": "", "port": 465, "from": "", "auth": { "user": "", "pass": "" } }, ... } ``` 注意:这里的 `servername` 应该设置为 `mongo`,因为我们将使用官方的 MongoDB 镜像作为数据库。 5. 确保你的 Docker 服务已经启动,然后在 yapi 文件夹中运行以下命令启动 Yapi 容器: ``` docker-compose up -d ``` 6. Yapi 容器启动后,你可以通过浏览器访问 `http://localhost:3000` 来访问 Yapi。 这样,你就成功在 Docker 中安装了 Yapi。记得根据你的实际需求进行配置,并确保相关端口没有被占用。希望对你有所帮助!如有其他问题,请随时提问。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值