zl程序教程

您现在的位置是:首页 >  工具

当前栏目

[ 环境搭建篇 ] docker 搭建部署 YAPI 框架

Docker部署框架 环境 搭建
2023-09-27 14:29:30 时间

🍬 博主介绍

👨‍🎓 博主介绍:大家好,我是 _PowerShell ,很高兴认识大家~
✨主攻领域:【渗透领域】【数据通信】 【通讯安全】 【web安全】【面试分析】
🎉点赞➕评论➕收藏 == 养成习惯(一键三连)😋
🎉欢迎关注💗一起学习👍一起讨论⭐️一起进步📝文末有彩蛋
🙏作者水平有限,欢迎各位大佬指点,相互学习进步!

Yapi介绍

Yapi是一个高效、易用、功能强大的接口文档管理工具,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API。
Yapi旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API。

优点:

1、提供基本的项目分组,项目管理,接口管理功能
2、友好的接口文档,基于websocket的多人协作接口编辑功能和类postman测试工具,让多人协作成倍提升开发效率
3、基于Mockjs,使用简单功能强大

Yapi的几个功能

权限管理:
YApi 成熟的团队管理扁平化项目权限配置满足各类企业的需求。
可视化接口管理:
基于 websocket 的多人协作接口编辑功能和类 postman 测试工具,让多人协作成倍提升开发效率。
Mock Server:
易用的 Mock Server,再也不用担心 mock 数据的生成了
自动化测试:
完善的接口自动化测试,保证数据的正确性
数据导入:
支持导入 swagger, postman, har 数据格式,方便迁移旧项目
插件机制:
强大的插件机制,满足各类业务需求

1、启动 MongoDB

前提需要安装docker:安装docker:

https://blog.csdn.net/qq_51577576/article/details/125048165

由于YApi依赖于MongoDB,所以我们需要下载并启动MongoDB。

docker run -d --name mongo-yapi mongo

在这里插入图片描述

2、获取 Yapi 镜像,版本信息可在 阿里云镜像仓库 查看

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

在这里插入图片描述

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

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

在这里插入图片描述

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

在这里插入图片描述

5、Yapi 部署成功

访问 http://localhost:3000 登录账号 admin@admin.com,密码 ymfe.org

http://localhost:3000

在这里插入图片描述
在这里插入图片描述