Fork me on GitHub

接口管理平台YAPI

前言

有没有为维护接口文档而烦恼过?

作为一个良好的开发人员,为使用者提供准确良好的接口文档也是开发的一部分。

也便于测试创建测试用例。

接口管理有很多种方式,很多是提供接口文档供使用者参考,也有一些是通过平台管理。

今天介绍一款非常好用的工具,YAPI,其主要功能是一款优秀的API接口管理平台。旨在为开发、产品、测试人员提供更优雅的接口管理服务。

我在使用这个API管理平台时,感觉还蛮不错的,特此介绍下。

官网地址https://yapi.ymfe.org/

我们搭建内网环境,把这款接口管理平台在内网部署下,并且简单使用下。

正文

要搭建内网环境,首先要准备以下几个软件。

  1. nodejs (必须)
  2. mongodb (必须)
  3. git (非必须)

git主要是从GitHub上 clone项目的,如果采用可视化安装或者直接下载压缩包是用不到的。

没有以上软件的需要下载安装。

nodejs下载

upload successful

mongodb下载

upload successful

安装不做过多介绍,自己参考一些资料即可完成。

对于YAPI服务,我们采用可视化部署,执行命令:

1
npm install -g yapi-cli --registry https://registry.npm.taobao.org

注:其他部署方式,详情可以查看官方文档 https://yapi.ymfe.org/devops/index.html

这儿不做讨论。

安装成功后启动 yapi server,执行命令:

1
yapi server

通过浏览器打开页面 http://0.0.0.0:9090/

会看到如下界面:

upload successful

注意:需要启动mongdb数据库。

mongodb启动备注(路径未加入PATH):

1
2
cd /Users/zhangwentong/Applications/mongodb/mongodb-osx-x86_64-4.0.4/bin
./mongod --dbpath /Users/zhangwentong/Applications/mongodb/data/db

部署引导完成后。我们进入到vendors 文件夹,启动YAPI服务。如下命令:

1
2
cd my-yapi/vendors/
node server/app.js

upload successful

说明我们安装完成并启动成功了。浏览器打开图上地址。

upload successful

使用管理员账号登陆,初始密码为 ymfe.org

其他人可以进行注册后登陆。

登陆成功后如下图:

upload successful

我们可以在个人中心修改密码,这儿就不做过多介绍了。看一看它的主要功能吧。

首先我们创建一个分组。

upload successful

然后我们在该分组里创建一个项目。

upload successful

upload successful

上图的成员列表里可以添加成员,把一起开发的开发者拉进来。

分组动态展示我们分组的一些操作等。

我们可以看到项目里内容如下:

upload successful

接口主要就是用来管理我们的接口的界面,比如后台提供某些接口,全部放在里面,供其它开发人员查看使用。

动态代表着这个项目里的接口等改动动态,方便人员查看。

成员管理可以管理这个项目的成员,指定组长,开发者,外部接口使用者(访客)等。

然后我们可以添加一些模块接口分类。如下,不同接口放在不同模块下。

upload successful

继续,我们新增加一个接口来看看吧。

upload successful

新增OK后对接口进行修改。

upload successful

当我们接口参数定义好,或者说后台接口完成后(可以测试时),我们应该把接口状态改为已完成

一个写好的接口demo如下:

upload successful

同时动态里也可以看到我们对于接口的改动。

upload successful

同时YAPI还支持测试接口,mock,wiki等,类似于Postman等工具。

upload successful

这儿就不过多介绍了,对于我们开发人员,最主要的应该属对接口文档的维护了,也就是刚才介绍的部分。

结语

今天说到这里也差不多啦,YAPI还可以控制人员的权限、给指定人员发送邮件、设置是否可以注册等其它功能,有兴趣的可以摸索。

我们对YAPI的使用就是用其对接口文档进行管理。它是易用的简便的。

在项目开发过程中,在公司服务器上搭建一套环境,对组成员接口文档维护也是受益的。




-------------文章结束啦 ~\(≧▽≦)/~ 感谢您的阅读-------------

SakuraTears wechat
扫一扫关注我的公众号
您的支持就是我创作的动力!
0%