YApi简介:开源的接口管理平台

本文介绍了什么是 YApi,以及它的特点和优势,帮助读者了解并快速上手这个开源接口管理平台。

用 Apifox,节省研发团队的每一分钟

YApi简介:开源的接口管理平台

免费使用 Apifox

相关推荐

最新文章

API

一体化协作平台

API 设计

API 文档

API 调试

自动化测试

API Mock

API Hub

立即体验 Apifox
目录

YApi 是什么?

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

YApi 的 特点

  • 权限管理: YApi 拥有比较成熟的团队管理扁平化项目权限配置,它可以满足各类企业的需求
  • 可视化接口管理: 使用 websocket 技术开发的多人协作接口编辑功能,让多人协作 成倍提升开发效率
  • Mock Server: 简单快捷的 Mock Server 应用, mock 数据的生成非常方便
  • 自动化测试: 比较完善的接口自动化测试,保证数据的正确性
  • 数据导入: 支持导入 Swagger, Postman, Har 数据格式,方便迁移旧项目
  • 插件机制: 比较强大的插件机制,它可以满足各类业务需求

官方文档

https://yapi.ymfe.org/documents/index.html

搭建YApi

当然前提是你的服务器安装有 Docker

创建 MongoDB 数据卷

docker volume create mongo_data_yapi

启动 MongoDB

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

获取 YApi 镜像

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

初始化 YApi 数据库索引及管理员账号

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

自定义配置文件挂载到目录 /api/config.json

cd  /var/lib/docker
mkdir  api
touch config.json

config.json

{
"servername": "127.0.0.1",
"DATABASE": "yapi",
"port": 27017,
"user": "test1",
"pass": "test1",
"port": "3000",
"adminAccount": "admin@admin.com",
"host": "smtp.163.com",
"port": 465,
"from": "  @163.com",   "db": {   "authSource": ""   },   "mail": {   "enable": true,    "auth": {   "user": "  @163.com",
"pass": " * "
  }
 }
}

启动 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
curl 127.0.0.1:3000

访问YApi

访问YApi
访问 Yapi

小结

可以发现 Yapi 成功启动起来了,我们可以进行接口管理、接口mock、接口调试、接口测试等操作,但是还是略显麻烦,有没有不需要过多部署与配置就可以拥有这些功能的工具呢?

接下来介绍这一款工具 Apifox

Yapi 更好用的工具 Apifox

Apifox 是一体化 API 协作平台,可以实现 API 文档、API 调试、API Mock、 API 自动化测试,是更先进的 API 设计/开发/测试工具。

使用 Apifox ,你可以在一个统一的平台上设计、调试、测试以及协作你的 API,消除了在不同工具之间切换和数据不一致的问题。 简化了你的 API 工作流,并确保了前端、后端和测试人员之间的高效协作。

Apifox 创建团队、项目、接口

新建团队

点击 新建团队,并填入 团队名:

Apifox 创建团队、项目、接口
新建团队

新建项目

点击 新建项目,并设置项目名称和权限。

Apifox 创建团队、项目、接口
新建项目

新建接口

然后就可以新建接口啦!

Apifox 创建团队、项目、接口
新建接口

接口功能

Apifox 的 API 管理功能包括:

  • 接口管理
  • Mock、高级 Mock
  • 环境管理
  • 接口自动化测试
  • 数据库连接

接口管理、环境管理、Mock功能

apifox Mock功能
接口管理

自动化接口测试

在使用 Apifox 进行接口测试时,可以通过简单的拖放操作来构建测试用例,快速生成测试报告,轻松地分享测试结果。同时,Apifox 还提供了多种测试方式,如单个接口测试、多个接口测试、定时任务等,以满足不同测试场景的需求。

apifox 自动化接口测试
自动化接口测试

数据库连接

前置操作、后置操作支持添加数据库操作,可读写数据库数据,查询结果可在接口请求参数、断言、自定义脚本等场景中使用。目前支持MySQL、SQL Server、Oracle、PostgreSQL,未来会支持更多数据库类型。

apifox 数据库连接
数据库连接

Apifox

Apifox 的定位是:

  • API 文档、API 调试、API Mock、API 自动化测试
  • 更先进的 API 设计/开发/测试工具
  • Apifox = Postman + Swagger + Mock + JMeter

Apifox 是国内 API 管理工具的龙头,没有使用过的建议体验一下:点击免费使用