YAPI-1.8.5 安装使用

解决痛点

1,跨团队协作API变更怎同步通知。(使用YAPI,CICD流水线邮件通知)

2,JAVA使用SWAGGER2进行API传统和简单测试,上线时需要干掉(多一事不如少一事)。

    当然这里可以设定linux环境变量让程序加载时判断是否打开SWAGGER。我们选择软件工程利率无用的程序代码不上线。

3,集中的API管理,写了很多文档与你对接的同学不一定会看,不如给他让他API秒懂(别再使用单机OFFER文件传递了,最起码也要用腾讯文档啊)。

4,我只想愉快的写代码,谁能帮我做MOCK和冒烟测试。(YAPI 自动生成MOCK服务,YAPI自动生成冒烟用例)

简介

    YApi来自去哪网工程效率团队,让接口开发更简单高效,让接口的管理更具可读性、可维护性,让团队协作更合理。主要功能模块如下。

项目管理:提供基本的项目分组,项目管理,接口管理功能。

接口管理:友好的接口文档,基于websocket的多人协作接口编辑功能和类postman测试工具,让多人协作成倍提升开发效率。

MockServer:基于Mockjs,使用简单功能强大。


私有化源码部署

环境准备

操作系统:centos 7

环境要求:

nodejs>7.6

mongodb>2.6

git

安装nodejs

获取资源(部署nodejs尽可能选择偶数版本,因为偶数版本官方有较长的维护时间,故这次选择8.x。)

curl -sL https://rpm.nodesource.com/setup_8.x | bash -

安装

yum install -y nodejs

查看版本

node -v

查看npm版本

npm -v

安装mongodb

更新yum源,非必须但是更新一下无害

yum -y update

添加mongodb源文件,在/etc/yum.repos.d 创建一个 mongodb-org.repo 文件

touch /etc/yum.repos.d/mongodb-org.repo

编辑mongodb-org.repo文件

vim /etc/yum.repos.d/mongodb-org.repo

添加文件内容

[mongodb-org]name=MongoDBRepository

baseurl=http://mirrors.aliyun.com/mongodb/yum/redhat/7Server/mongodb-org/3.2/x86_64/

gpgcheck=0

enabled=1


安装mongodb

yum install -y mongodb-org

启动mongodb

service mongod start

设置开机启动

chkconfig mongod on

打开moMongoDB(可忽略)

/bin/mongo

配置远程访问

修改mongod.conf配置文件

vim/etc/mongod.conf

注释 bindIp: 127.0.0.1

#bindIp: 127.0.0.1

重启mongod

service mongod restart

安装git

官方推荐,在内网部署的时候安装git,可以根据自己所需安装

yum -y install git

搭建YApi环境

准备环境搭建完成后,开始搭建YApi,安装命令

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

yapi server

访问机器所在IP XXX.XXX.XXX.XXX:9090安装。 选择1.8.5版本。


安装成果后在宿主机终端将看到

     初始化管理员账号成功,账号名:"[email protected]",密码:"ymfe.org"

启动它

cd /opt/my-yapi

node vendors/server/app.js &

访问http://部署YApi服务器的IP:3000/login

输入默认密码登入 "[email protected]",密码:"ymfe.org"

如果安装版本错误需要清除数据如下:

删除mongo 数据

show dbs

use  xx

db.dropDatabase()


谷歌浏览器插件安装

1.下载扩展 zip

下载链接 首先手动下载 zip 文件,然后解压


2.打开 chrome://extensions

必须开启开发者模式

3.然后点击加载已解压的扩展程序


简单演示使用场景(你还可以swagger json导入)


   创建一个项目

创建项目

创建接口


http://10.150.125.28:8084/api/business/purchase/commit



项目基本接口设计
创建接口


设置好就可以运行了!(这个只是GET无参数哦)

你可能感兴趣的:(YAPI-1.8.5 安装使用)