YAPI管理平台

YAPI管理平台

一、什么是YAPI

• YAPI 是一款高效，易用，功能强大的API管理平台，目的是为了给开发、产品、测试人员提供更优雅的接口管理服务。
• YAPI 支持基本的项目管理，可视化的接口管理，Mock Server，自动化测试，swagger，postman，har格式数据导入，以及插件机制来满足各种业务需求。

二、YAPI使用教程

1. YAPI网站注册账号

  YAPI 官网首页
  YAPI 接口管理平台

三、内网部署

1. 环境要求

• nodejs(7.6+)
• mongodb(2.6+)
• git

2. 安装

【方式一】可视化部署（推荐）
  执行 yapi server 启动可视化部署程序，输入相应的配置和点击开始部署，就能完成整个网站的部署。部署完成之后，可按照提示信息，执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱，默认密码(ymfe.org) 登录系统（默认密码可在个人中心修改）。

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

【方式二】命令行部署
 emsp;如果 github 压缩文件无法下载，或需要部署到一些特殊的服务器，可尝试此方法

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配置的端口}，初次运行会有个编译的过程，请耐心等候

安装后的目录结构如下：

|-- config.json
|-- init.lock
|-- log
`-- vendors
    |-- CHANGELOG.md
    |-- LICENSE
    |-- README.md
    |-- client
    |-- common
    |-- config_example.json
    |-- doc
    |-- exts
    |-- nodemon.json
    |-- npm-debug.log
    |-- package.json
    |-- plugin.json
    |-- server
    |-- static
    |-- test
    |-- webpack.alias.js
    |-- yapi-base-flow.jpg
    |-- ydocfile.js
    `-- ykit.config.js

安装后,将会在数据库生成管理员账号,修改 config.json 管理员账号将会无效。

转载于:https://my.oschina.net/tyk1314/blog/2222510