Docker实战:docker安装YApi接口管理工具

举报
IT技术分享社区 发表于 2022/10/20 21:28:08 2022/10/20
【摘要】 YApi是一款高效、易用、功能非常强大的 api 可视化接口管理平台,旨在为互联网公司的技术人员提供更优雅的接口管理服务系统。它可以帮助开发者快速创建、发布、维护 API接口,并且YApi为用户提供了优秀的交互体验,技术人员只需利用平台提供的接口数据写入工具以及很少的点击操作就可以实现接口的管理。

1、YApi介绍

YApi是一款高效、易用、功能非常强大的 api 可视化接口管理平台,旨在为互联网公司的技术人员提供更优雅的接口管理服务系统。它可以帮助开发者快速创建、发布、维护 API接口,并且YApi为用户提供了优秀的交互体验,技术人员只需利用平台提供的接口数据写入工具以及很少的点击操作就可以实现接口的管理。

官网:http://yapi.dapengjiaoyu.com/

2、YApi功能介绍

YApi的口号是“Api让接口开发更简单高效,让接口的管理更具可读性、可维护性,让团队协作更合理”。

技术架构:nodeJS+mongodb

具体功能如下:

项目管理:提供基本的项目分组、项目基本信息管理、项目接口管理

接口管理:基于websocket的多人协作接口编辑功能和功能类似于postman测试工具,多人协作的发效率非常高

Mock服务:集成目前最流行的Mock服务,接口测试非常方便

扁平化管理:引入了产品管理权限的概念,不同角色做不同的事情。

超级管理员:创建分组、分配组长、管理所有成员

组长:创建项目、管理项目、分组信息、管理小组成员开发者

开发者:只有接口相应的管理权限

自动化测试:

完善的接口自动化测试,保证数据的正确性,支持对 Response 断言

3、YApi带来的好处

针对互联网开发公司,一般开发人员规模几十个左右,每个人可能都会负责一部分接口开发的工作,一般公司都会有要求接口管理规范,这样对后续的运维非常重要。传统的方式采用word、excel等文档留存,或者使用swagger进行管理。这样的接口管理过于分散、文档也比较容易丢失、更新不及时等缺点。使用YApi可以很好的解决这些问题,为后续的运维或者新人入职接手项目会更加的容易。

4、Docker 部署YApi

4.1 安装mongodb

安装目录

#拉取mongodb镜像
docker pull mongo:4.2
#运行mongodb容器
docker run \
-d \
--name mongo \
--restart=always \
--privileged=true \
-p 27017:27017 \
-v /home//mongodb/data:/data/db \
mongo:4.2 --auth
#配置mongodb
#进入容器
docker exec -it mongo /bin/bash
#登录mobodb
mongo admin 
#创建一个名为 root,。
db.createUser({
       
         
          user:'root',pwd:'你的密码',roles:[ {
       
         
          role:'userAdminAnyDatabase', db: 'admin'},"readWriteAnyDatabase"]});

测试mongodb是否安装成功

IP+27017端口方式测试mongodb是否可以正常访问

注意:确认服务器中27017端口开放、防火墙对应的27017端口开放

4.2 安装Yapi

拉取镜像

docker pull jayfong/yapi:1.10.2

image_bd60f858.png

运行容器

docker run \
-d \
--name yapi \
--restart=always \
--privileged=true \
-p 3000:3000 \
-e YAPI_ADMIN_ACCOUNT=admin@qq.com \
-e YAPI_ADMIN_PASSWORD=123456 \
-e YAPI_CLOSE_REGISTER=true \
-e YAPI_DB_SERVERNAME=你的公网IP \
-e YAPI_DB_PORT=27017 \
-e YAPI_DB_DATABASE=yapi \
-e YAPI_DB_USER=root \
-e YAPI_DB_PASS=你的密码\
-e YAPI_DB_AUTH_SOURCE=admin \
-e YAPI_MAIL_ENABLE=false \
-e YAPI_PLUGINS=[] \
jayfong/yapi:1.10.2

运行效果如下图

image_bfd0b2af.png

访问YApi测试

首先云服务器开放3000端口,防火墙配置3000端口开放或者禁用防火墙。

image_dc388514.png

登录YApi

image_4c90b495.png

主界面

image_739cca13.png

【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

举报
请填写举报理由
0/200