YApi 接口文档内网部署到 Windows&Linux

当前位置: 首页 » 文章 » YApi 接口文档内网部署到 Windows&Linux

分类: 文章 1,824阅读阅读模式

YApi 是高效易用功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

 

Windows 部署:

部署环境:window server 2012、node.js_v10.15、MongoDB_v4.0.5

1、安装 node.js 环境  传送门>>Node.js 安装与配置

安装选择版本建议选择 LTS 版,安装包建议选择二进制包 「.msi」

1.1、安装 npm ,新版本 node.js 默认集成 npm ,输入 npm -v ,如出现版本号则表示已安装

 

2、安装 MongoDB (2.6+) 传送门>>Windows 平台安装 MongoDB传送门>>Linux平台安装MongoDB

安装包建议选择二进制包 「.msi」 ,下载后安装,安装过程去掉勾选 “install mongoDB compass”,如下图

3、安装 Git 传送门>>Git 安装与配置

 

4、安装 YApi ,步骤教程 官网传送门>>

4.1、创建文件夹 yapi ,在 yapi 文件夹中打开命令行(cmd/终端),下载到本地

  1. git clone https://github.com/YMFE/yapi.git vendors

4.2、复制配置文件到当前目录

  1. cp vendors/config_example.json ./config.json

4.3、执行安装依赖

  1. cd vendors
  2. npm install --production --registry https://registry.npm.taobao.org

4.4、安装程序(初始化数据库和管理员账号),默认在 yapi 文件夹下面的 config.json 配置

注意:执行该步骤前确保 MongoDB 已成功安装并运行,并且已经创建了与 config.js 对应的数据库名称(默认数据库名称配置为 yapi )

  1. npm run install-server

4.5、启动服务器,默认为 config.json 配置里面的端口

  1. node server/app.js

安装后的目录大概这样:

  1. └─yapi
  2.     ├─config.json
  3.     ├─init.lock
  4.     └─vendors
  5.         ├─client
  6.         ├─common
  7.         ├─docs
  8.         ├─exts
  9.         ├─server
  10.         ├─static
  11.         ├─test
  12.         ├─.eslintignore
  13.         ├─.eslintrc.js
  14.         ├─.gitignore
  15.         ├─.npmrc
  16.         ├─.package.json.swp
  17.         ├─CHANGELOG.md
  18.         ├─config_example.json
  19.         ├─LICENSE
  20.         ├─nodemon.json
  21.         ├─package.json
  22.         ├─plugin.json
  23.         ├─README.md
  24.         ├─webpack.alias.js
  25.         ├─yapi-base-flow.jpg
  26.         ├─ydoc.js
  27.         ├─ydocfile.js
  28.         └─ykit.config.js

4.6、添加到系统启动项中

默认的,如果系统重启,这个就需要重新打开,很麻烦,所以,根据官方推荐,使用 pm2 管理 node 服务器启动

4.6.1、安装 pm2

  1. npm install pm2@latest -g

4.6.2、在 vendors 中打开命令行,执行

  1. pm2 start server/app.js --watch

 

完成!

 

备注1:创建 MongoDB 数据库,并创建对应用户

  1. use yapi
  1. db.createUser({user:'yapi',pwd:'123456',roles:[{role:'dbOwner',db:'yapi'}]})

 

备注2: config.json 默认配置

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

 

相关文章

评论一下

【注意1】:首次评论使用表情将会进入审核状态。
【注意2】:无意义回复、乱打文字内容将会进入审核状态。
【注意3】:涉及辱骂、色情、政治、毒品、赌博内容将会进入审核状态。
【注意】:首次评论使用表情将会进入审核状态。

相关评论 当前评论 1 条 [ 游客 1 | 博主 0 ]

  1. Maker [] @回复
    ① 楼 6 个月前

    :smile: 讲得不错!

    0
    0