YApi 是一款开源、可视化的接口管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。 它可以帮助团队更轻松地管理和共享API接口文档、Mock数据、接口测试等。开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

YApi具有以下特点：

• 可视化接口管理：YApi提供了可视化的接口管理界面，可以方便地创建、编辑和查看接口文档。

• 接口Mock：YApi可以根据接口文档自动生成Mock数据，方便前端和后端开发人员进行接口调试。

• 接口测试：YApi提供了接口测试功能，可以方便地对接口进行测试并查看测试结果。

• 团队协作：YApi支持团队协作，可以创建多个团队，并对接口文档进行权限管理。

• 导入导出：YApi支持导入和导出接口文档，方便在不同环境之间进行接口文档的迁移和共享。

官网：

https://github.com/YMFE/yapi

安装部署

部署YApi可以选择使用官方提供的Docker镜像，也可以手动部署。下面是手动部署YApi的简要步骤：

1、下载YApi源代码：可以从YApi的GitHub仓库下载最新的源代码。

2、安装Node.js和MongoDB：YApi依赖Node.js和MongoDB，需要先安装这两个软件。

3、安装YApi依赖：在YApi源代码目录下，运行以下命令安装YApi的依赖：

npm install --production --registry https://registry.npm.taobao.org

4、配置YApi：在YApi源代码目录下，复制config_example.json文件并重命名为config.json，然后根据实际情况配置config.json文件，包括MongoDB的连接信息、邮件配置等。

5、启动YApi：在YApi源代码目录下，运行以下命令启动YApi：

node server/app.js

6、访问YApi：在浏览器中访问http://localhost:3000，即可进入YApi的管理界面。

以上是手动部署YApi的简要步骤，实际部署过程可能会根据具体情况有所不同。在实际生产环境中，建议使用Docker进行部署，以简化部署和管理过程。

要使用Docker部署YApi，你可以按照以下步骤进行操作：

1. 安装Docker和Docker Compose：如果你的机器上还没有安装Docker和Docker Compose，可以按照官方文档的说明进行安装。

2. 创建YApi的Docker Compose文件：在一个新的目录下，创建一个名为docker-compose.yml的文件，并添加以下内容：

version: '3'
services:
  yapi:
    image: 'ymyzk/yapi'
    container_name: yapi
    ports:
      - '3000:3000'
    environment:
      - TZ=Asia/Shanghai
    volumes:
      - ./config.json:/app/config.json
    networks:
      - yapi-net
    depends_on:
      - mongo
  mongo:
    image: 'mongo:3.4'
    container_name: yapi-mongo
    ports:
      - '27017:27017'
    volumes:
      - ./mongo_data:/data/db
    networks:
      - yapi-net
networks:
  yapi-net:
    driver: bridge

在这个Docker Compose文件中，我们定义了两个服务：yapi和mongo。yapi服务使用了YApi的官方Docker镜像，mongo服务使用了官方的MongoDB镜像。我们将YApi的配置文件config.json挂载到了yapi服务中，以便配置YApi的参数。

1. 创建YApi的配置文件：在与docker-compose.yml文件相同的目录下，创建一个名为config.json的配置文件，根据实际情况配置YApi的参数，例如MongoDB的连接信息、邮件配置等。

2. 启动YApi：在包含docker-compose.yml文件和config.json文件的目录下，运行以下命令启动YApi：

docker-compose up -d

这将启动YApi和MongoDB的Docker容器，并在后台运行。

1. 访问YApi：在浏览器中访问http://localhost:3000，即可进入YApi的管理界面。通过以上步骤，你就可以使用Docker快速部署YApi，并开始管理和共享API接口文档了。

如果你不想在本地搭建，也可以直接访问官方站点：

http://yapi.mglicai.com/

如果觉得有用，就请关注、点赞、在看、分享到朋友圈吧！

推荐阅读：

1. 重磅消息 | 2023年最新全栈测试开发技能实战指南V2.0（第4期）
   

2. 史上最全测试开发工具推荐（含自动化、APP性能、稳定性、抓包神器）

3. 推荐几款常用测试数据自动生成工具（适用自动化测试、性能测试）
   

END

所有原创文章

第一时间发布至此公众号「测试开发技术」

长按二维码/微信扫码  添加作者