YApi - 高效、易用、功能强大的可视化接口管理平台

YApi

  YApi是由去哪儿网移动架构组(简称YMFE,一群由FE、iOS和Android工程师共同组成的最具想象力、创造力和影响力的大前端团队)开源的可视化接口管理工具,一个可本地部署的、打通前后端及QA的接口管理平台,YApi旨在为开发、产品和测试人员提供更优雅的接口管理服务,可以帮助开发者轻松创建、发布和维护不同项目,不同平台的API。有了YApi,我们可以很方便的测试、管理和维护多个项目的API接口,不像Swagger那样是随应用生和灭的(且线上环境下大多数须关闭),YApi是一个独立的服务平台。

YApi

安装YApi

1. 环境说明

  • Centos7
  • NodeJS v7.6+
  • MongoDB v2.6+
  • Git (可选)

2. NodeJS安装

  安装这个遇到点坑,因为系统是CentOS的,所以一开始很自然用上了yum -y install nodejs,没想到安装出来的node版本太低了,无奈又用命令yum remove -y nodejs npm卸载掉并重新安装,之后找到了Node官网的安装说明 ,参考操作如下:

sudo yum install gcc-c++ make

curl -sL https://dl.yarnpkg.com/rpm/yarn.repo | sudo tee /etc/yum.repos.d/yarn.repo

sudo yum install yarn

curl --silent --location https://rpm.nodesource.com/setup_10.x | sudo bash -

sudo yum -y install nodejs

3. MongoDB安装

  为了简便,这里用docker运行mongo服务。

// 1.运行mongo服务,因为是测试所以也不设置用户名密码了
docker run -d --name yapi-mongo -p 27017:27017 mongo
// 2.进入mongo服务
docker exec -it yapi-mongo bash
// 3.进入mongo交互命令环境
mongo
// 4.创建名为yapi的DB,这个在可视化部署用得上
use yapi
// 5.查看所有DB
show dbs

4.1 可视化部署及启动[推荐]

// 1. 用npm安装yapi客户端
    npm install -g yapi-cli --registry https://registry.npm.taobao.org
// 2. 启动客户端安装服务
    yapi server

  执行完第2步的yapi server后系统将自动运行可视化部署程序(http://localhost:9090),输入相应的配置并点击开始部署。

YApi平台部署

  部署完成之后,根据部署日志提示信息切换到部署目录,输入指令node vendors/server/app.js启动服务器。

部署日志

4.2 命令行部署及启动[此方法请自行测试]

mkdir yapi
cd yapi
git clone https://github.com/YMFE/yapi.git vendors //或者下载 zip 包解压到 vendors 目录
cp vendors/config_example.json ./config.json //复制完成后请修改相关配置
cd vendors
npm install --production --registry https://registry.npm.taobao.org
npm run install-server //安装程序会初始化数据库索引和管理员账号,管理员账号名可在 config.json 配置
node server/app.js //启动服务器后,请访问 127.0.0.1:{config.json配置的端口},初次运行会有个编译的过程,请耐心等候

使用YApi

  如果部署的时候使用的是默认端口配置,那网站访问的地址就是:http://localhost:3000 ,初始管理员账号:admin@admin.com,密码:ymfe.org(可在个人中心修改)。

YApi - Login

YApi - 主界面

  具体的操作和使用请查看官方文档:YApi-教程,包括Mock测试、自动化测试、数据导入导出等都有详细的介绍。

相关链接

YApi - 官网 YApi - GitHub

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏编程微刊

基于mpvue的小程序项目搭建的步骤步骤1. 检查下 Node.js 是否安装成功

21930
来自专栏美团技术团队

监控平台前端SDK开发实践

背景 监控是提高故障处理能力和保障服务质量必需的一环,它需要负责的内容包括:及时上报错误、收集有效信息、提供故障排查依据。 及时上报错误:发生线上问题后,经由运...

38580
来自专栏无题

软负载中心与集中配置管理

软负载中心两个最基础的职责 聚合地址信息 生命周期感知->需要能对服务的上下线自动感知,并且根据这个变化去更新服务地址数据 软负载中心两个最基础的职责 聚合...

32740
来自专栏hbbliyong

用Visual Studio Code写Node.j

介绍 vsc的宣传语是: 一个运行于 Mac OS X、Windows和 Linux 之上的,针对于编写现代 Web 和云应用的跨平台源代码编辑器。 按它说的...

397130
来自专栏BeJavaGod

文档!重要的事情说第四遍~

之前我有提过文档的事,标题是《文档!文档!文档!重要的事情说三遍!》,其中提到的文档工具是使用wiki来管理文档,当然也能配合jira来分发任务,以及管理bug...

28830
来自专栏CLS日志服务

腾讯云CLS日志服务应用

*LogListener: 是腾讯云日志服务提供的日志采集 Agent,通过在服务器上安装loglistener可以实时采集指定路径上的日志,并对日志原始数据进...

48610
来自专栏编程

Python让你自己做一个软件,自己开个聊天室,厉害吧!

内容 知识点 asyncore 、asynchat模块运用 环境 python 3.5 功能描绘 在本实验中,我们将实现一个简略的图形界面谈天系统。我们可以经...

34450
来自专栏公有云大数据平台弹性 MapReduce

简单了解公平调度器的一些队列设置

在腾讯云EMR的用户日常反馈中,经常会遇到因为YARN的队列配置不合理导致资源利用率不高,任务提交不上的问题,所以有了以下的文章,方便用户在日常按照一定的需求将...

24720
来自专栏九彩拼盘的叨叨叨

我理想中的前端团队需要具备的

9310
来自专栏架构师之路

php使用tcp长连接的一种优化思路

一、面向人群 如果站点架构满足以下几点,那么本文的优化方案会非常适合: 1)使用php等脚本语言作为开发语言 2)需要连接后端服务,例如RPC服务、memcac...

41460

扫码关注云+社区

领取腾讯云代金券