Yapi安装部署详细图文教程

 更新时间:2022年09月05日 11:53:06   作者:hjb2722404  
YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台,下面这篇文章主要给大家介绍了关于Yapi安装部署的相关资料,文中通过图文介绍的非常详细,需要的朋友可以参考下

Yapi安装部署教程

1.1 环境准备

  • nodejs > 7
  • mongodb > 2.6

1.2 安装命令行工具

1.2.1 全局安装 yapi-cli ,yapi的命令行工具

$ npm i yapi-cli -g

1.2.2 全局安装 ykit , yapi打包工具

$ npm i ykit -g

1.3 安装

在硬盘上新建一个用来安装yapi 的目录,在目录下调出命令终端,执行以下命令:

$ yapi server

可视化安装指引程序会运行在 http://localhost:9090 端口,浏览器访问这个地址,可以看到安装界面:

这里部署版本我们选择 【1.9.2】,这是后面要安装的钉钉通知插件最新支持到的版本。其它选项保留默认,直接点击【开始部署】

1.4 运行

等待部署完成,关闭之前的终端,在yapi安装目录下,打开一个新的终端,执行以下命令:

$ node vendors/server/app.js

执行后,yapi前端程序会运行在 http://localhost:3000 端口,打开浏览器访问这个地址,就可以看到安装好的yapi首页了:

当然,你可以使用 pm2 来管理这个服务。具体参考官方文档。

1.5 登陆

点击首页的【登陆】按钮,默认管理员账号为 【admin@admin.com / ymfe】,可以使用此账号登陆,就可以开始使用YAPI了管理你的API了。 如果不是管理员,可以点击【注册】,来注册一个账号。

2 容器安装

使用容器安装yapi

我们选用mrjin/yapi 这个docker镜像来安装。

准备:

  • linux服务器
  • docker 和 docker-compose

在服务器上拉取镜像:

$ docker pull mrjin/yapi:latest

在服务器上新建一个目录,我们此处举例建立 /home/yapi 目录:

$ mkdir /home/yapi

在上面新建的目录下,新建·docker-compose.yml

# /home/yapi$ touch docker-compose.yml

编辑docker-compose.yml 文件,填充以下内容:

// /home/yapi/docker-compose.yml

version: '2.1'
services:
  yapi:
    image: mrjin/yapi:latest
    # build: ./
    container_name: yapi
    environment:
      - VERSION=1.9.3
      - LOG_PATH=/tmp/yapi.log
      - HOME=/home
      - PORT=3000
      - ADMIN_EMAIL=test@test.com  // 修改这里的默认管理员账号
      - DB_SERVER=mongo
      - DB_NAME=yapi
      - DB_PORT=27017
    # restart: always
    ports:
      - 127.0.0.1:3000:3000
    volumes:
      - ~/data/yapi/log/yapi.log:/home/vendors/log # log dir
    depends_on:
      - mongo
    entrypoint: "bash /wait-for-it.sh mongo:27017 -- entrypoint.sh"
    networks:
      - back-net
  mongo:
    image: mongo
    container_name: mongo
    # restart: always
    ports:
      - 127.0.0.1:27017:27017
    volumes:
      - ~/data/yapi/mongodb:/data/db #db dir
    networks:
      - back-net  // 这里的网络名要和下面新建的网络名一致
networks:
  back-net:
    external: true

创建docker通信网络

$ docker network create back-net

启动 docker-compose部署程序

$ docker-compose up -d

启动后,就可以在本地 http://localhost:3000 访问了。

总结

到此这篇关于Yapi安装部署详细图文教程的文章就介绍到这了,更多相关Yapi安装部署教程内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • nodejs+mongodb aggregate级联查询操作示例

    nodejs+mongodb aggregate级联查询操作示例

    这篇文章主要介绍了nodejs+mongodb aggregate级联查询操作,结合实例形式分析了基于nodejs的mongodb数据库级联查询相关操作技巧,需要的朋友可以参考下
    2018-03-03
  • React+react-dropzone+node.js实现图片上传的示例代码

    React+react-dropzone+node.js实现图片上传的示例代码

    本篇文章主要介绍了React+react-dropzone+node.js实现图片上传的示例代码,非常具有实用价值,需要的朋友可以参考下
    2017-08-08
  • 解决Node.js使用MySQL出现connect ECONNREFUSED 127.0.0.1:3306的问题

    解决Node.js使用MySQL出现connect ECONNREFUSED 127.0.0.1:3306的问题

    这篇文章主要介绍了解决Node.js使用MySQL出现connect ECONNREFUSED 127.0.0.1:3306报错的相关资料,文中将问题描述的很清楚,解决的方法也介绍的很完整,需要的朋友可以参考借鉴,下面来一起看看吧。
    2017-03-03
  • package.json各个属性说明详解

    package.json各个属性说明详解

    这篇文章主要介绍了package.json各个属性说明详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-03-03
  • Node.js中npx命令的使用方法及场景分析

    Node.js中npx命令的使用方法及场景分析

    NPM(Node Package Manager) 是Node.js提供的一个包管理器, 可以使用 NPM 来安装 node.js 包 ,npm 是从5.2版开始, 增加(自带)了 npx 命令,本文给大家分享Node.js npx命令使用,需要的朋友一起看看吧
    2021-08-08
  • node.js Promise对象的使用方法实例分析

    node.js Promise对象的使用方法实例分析

    这篇文章主要介绍了node.js Promise对象的使用方法,结合实例形式分析了node.js中Promise对象的功能、定义、调用方法及相关使用技巧,需要的朋友可以参考下
    2019-12-12
  • 基于Koa2写个脚手架模拟接口服务的方法

    基于Koa2写个脚手架模拟接口服务的方法

    这篇文章主要介绍了基于Koa2写个脚手架模拟接口服务的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-11-11
  • node搭建后台的实现步骤

    node搭建后台的实现步骤

    本文介绍了使用Node.js搭建后台的实现步骤,文章详细阐述了每个步骤的实现过程,并给出了示例代码,对于想要了解如何使用Node.js搭建后台的读者具有一定的参考价值
    2023-08-08
  • node NPM库promise 异步任务状态管理

    node NPM库promise 异步任务状态管理

    这篇文章主要介绍了node NPM库promise 异步任务状态管理
    2023-07-07
  • node.js中的fs.createReadStream方法使用说明

    node.js中的fs.createReadStream方法使用说明

    这篇文章主要介绍了node.js中的fs.createReadStream方法使用说明,本文介绍了fs.createReadStream方法说明、语法、接收参数、使用实例和实现源码,需要的朋友可以参考下
    2014-12-12

最新评论