windows环境下Yapi安装(接口文档)

最新推荐文章于 2024-08-20 15:46:33 发布

hezheqiang

最新推荐文章于 2024-08-20 15:46:33 发布

阅读量690

点赞数 1

分类专栏：架构文章标签：接口文档

本文链接：https://blog.csdn.net/hezheqiang/article/details/115727882

版权

架构专栏收录该内容

18 篇文章 1 订阅

订阅专栏

本文详细介绍了YAPI的安装步骤，包括node.js、mongoDB、git的安装，以及YAPI代码获取、依赖安装和服务器启动的过程。在安装完成后，还分享了一个小技巧，即如何利用swagger接口批量导入YAPI，提高工作效率。

摘要由CSDN通过智能技术生成

一、YAPI是什么

YAPI简介

二、Yapi的安装准备

1.安装node.js ，下载地址：http://nodejs.cn/download/

2.安装mongoDB

下载地址：https://www.mongodb.com/try/download/community

安装方法：https://blog.csdn.net/hezheqiang/article/details/115723662

创建数据库相关数据

mongo
show dbs
db.createUser({user:'root',pwd:'123456', roles:[{role:'userAdminAnyDatabase', db:'admin'}]})

3.安装git，参考地址：https://www.jianshu.com/p/414ccd423efc

4.安装Yapi

1）在d盘创建yapi 文件夹，通过dos命令进入该文件夹，然后执行以下命令获取Yapi代码

git clone https://github.com/YMFE/yapi.git vendors //或者下载 zip 包解压到 vendors 目录

在Yapi文件夹下创建config.json文件(db节点是配置mongo数据库连接)

{
  "port": "3000",
  "adminAccount": "admin@admin.com",
  "db": {
    "servername": "127.0.0.1",
    "DATABASE": "yapi",
    "port": 27017,
    "user": "root",
    "pass": "123456",
    "authSource": "admin"
  },
  "mail": {
    "enable": true,
    "host": "smtp.exmail.qq.com",
    "port": 465,
    "from": "xxx@xxx.cn",
    "auth": {
      "user": "xxx@xxx.cn",
      "pass": "xxx"
    }
  }
}

2)再执行以下命令


//1.执行npm依赖安装，会生成node_module目录：
cd vendors
npm install --production --registry https://registry.npm.taobao.org

//这一步很容易报错，这是一个bug，如果报错，请尝试：

npm install --production --registry https://registry.npm.taobao.org --unsafe-perm=true --allow-root

//2.npm依赖安装安装完成后执行yapi服务器安装：

npm run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置

这一步如果报错说Error: 初始化管理员账号 "yapiadmin" 失败，则根据打印信息去找是否是mongodb设置问题、config.json设置问题，成功的显示是这样的：