Docker搭建YApi环境及使用

清疚 2023-02-20 13:48 29阅读 0赞

# 1.YApi介绍 #

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

# 2.特点 #

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

# 3.安装 #

官方列举了好几种搭建方式，我试了几种，但是都没有成功，都卡在点击登陆的时候没反应了，所以我还是介绍我搭建成功的教程吧。灰尘简单。我是使用docker搭建的。

注：此教程默认你已经安装好了docker

**步骤一：创建mongoDB数据卷**

docker volume create mongo_data_yapi

![20200627194128223.png][]

**步骤二：启动 MongoDB**

docker run -d --name mongo-yapi -v mongo_data_yapi:/data/db mongo

![20200627194230610.png][]

**步骤三：从阿里云仓库获取yapi镜像**

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0RyZWFtX3h1bg_size_16_color_FFFFFF_t_70][]

**步骤四：初始化 Yapi 数据库索引及管理员账号**

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

![20200627194823314.png][]

**步骤五：创建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

![20200627194952844.png][]

接下来访问ip:3000来访问yapi服务

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0RyZWFtX3h1bg_size_16_color_FFFFFF_t_70 1][]

** 注册一个账号使用：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0RyZWFtX3h1bg_size_16_color_FFFFFF_t_70 2][]

**注册好会自动登陆进去：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0RyZWFtX3h1bg_size_16_color_FFFFFF_t_70 3][]

###  接下来就可以愉快的使用yapi了，这期主要将yapi环境的搭建，有空写一篇如何使用idea集成yapi插件轻松无代码侵入方便快捷测试自己的接口。 ###

***tip:可以在自己的公有云搭建一个这样的服务，然后就可以在任意地方方便的测试自己的接口了***

[20200627194128223.png]: https://img-blog.csdnimg.cn/20200627194128223.png
[20200627194230610.png]: https://img-blog.csdnimg.cn/20200627194230610.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0RyZWFtX3h1bg_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200627194532122.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0RyZWFtX3h1bg==,size_16,color_FFFFFF,t_70
[20200627194823314.png]: https://img-blog.csdnimg.cn/20200627194823314.png
[20200627194952844.png]: https://img-blog.csdnimg.cn/20200627194952844.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0RyZWFtX3h1bg_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200627195150983.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0RyZWFtX3h1bg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0RyZWFtX3h1bg_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200627195250124.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0RyZWFtX3h1bg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0RyZWFtX3h1bg_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200627195342327.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0RyZWFtX3h1bg==,size_16,color_FFFFFF,t_70