安装YApi

1.创建工程目录

  1. mkdir yapi && cd yapi
  2. git clone https://github.com/YMFE/yapi.git vendors --depth=1 # 或者下载 zip 包解压到 vendors 目录

2.修改配置

  1. cp vendors/config_example.json ./config.json # 复制完成后请修改相关配置
  2. vi ./config.json

配置如下，主要配置 MongoDB 数据库，以及 Admin 账号。

  1. {
  2.   "port": "3011",
  3.   "adminAccount": "admin@admin.com",
  4.   "db": {
  5.     "servername": "127.0.0.1",
  6.     "DATABASE":  "yapi",
  7.     "port": 27017,
  8.     "user": "yapi",
  9.     "pass": "yapi123"
  10.   },
  11.   "mail": {
  12.     "enable": true,
  13.     "host": "smtp.163.com",
  14.     "port": 465,
  15.     "from": "***@163.com",
  16.     "auth": {
  17.         "user": "***@163.com",
  18.         "pass": "*****"
  19.     }
  20.   }
  21. }

db.user 和 db.pass 是 mongodb 的用户名和密码，如果没有开启 mongo 认证功能，请删除这两个选项。

3.安装依赖

  1. cd vendors
  2. npm install  --registry https://registry.npm.taobao.org # 安装依赖

4.初始化

  1. npm run install-server  # 安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
  2. # 默认输出
  3. # 初始化管理员账号成功,账号名："admin@admin.com"，密码："ymfe.org"

5.启动开发机

  1. npm run dev
  2. # 启动服务器后，请访问 127.0.0.1:{config.json配置的端口}，初次运行会有个编译的过程，请耐心等候
  3. # 127.0.0.1:3011

目录结构

  1. |-- config.json
  2. |-- init.lock
  3. |-- log
  4. `-- vendors
  5.     |-- CHANGELOG.md
  6.     |-- LICENSE
  7.     |-- README.md
  8.     |-- client
  9.     |-- common
  10.     |-- config_example.json
  11.     |-- doc
  12.     |-- exts
  13.     |-- nodemon.json
  14.     |-- npm-debug.log
  15.     |-- package.json
  16.     |-- plugin.json
  17.     |-- server
  18.     |-- static
  19.     |-- test
  20.     |-- webpack.alias.js
  21.     |-- yapi-base-flow.jpg
  22.     |-- ydocfile.js
  23.     `-- ykit.config.js

技术栈说明

后端： koa mongoose

前端： react redux

启动开发环境服务器

  1.   cd vendors
  2.   npm run dev
  3.   # 启动服务器后，请访问 127.0.0.1:{config.json配置的端口}，初次运行会有个编译的过程，请耐心等候

启动生产环境服务器

  1.   cd vendors
  2.   ykit pack -m
  3.   node server/app.js