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实现简易WEB上传下载服务器

    NodeJs实现简易WEB上传下载服务器

    这篇文章主要为大家详细介绍了NodeJs实现一个简易WEB上传下载服务器,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-08-08
  • npm install -g 遇到权限问题解析

    npm install -g 遇到权限问题解析

    这篇文章主要为大家介绍了npm install -g 遇到权限问题解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-06-06
  • Node.js查找当前目录下文件夹实例代码

    Node.js查找当前目录下文件夹实例代码

    本篇文章主要介绍了Node.js查找当前目录下文件夹实例代码,具有一定的参考价值,有兴趣的可以了解一下。
    2017-03-03
  • NodeJS后端开发操作文件之读写文件

    NodeJS后端开发操作文件之读写文件

    这篇文章主要介绍了NodeJS后端开发操作文件之读写文件,操作文件是服务端一个基础的功能,也是做后端开发的必备能力之一,操作文件主要包括读和写。而这些功能NodeJS都已经提供了对应的方法
    2022-06-06
  • 手把手带你安装多个node版本

    手把手带你安装多个node版本

    在项目开发过程中,不同项目使用的node版本不同,有时会因为node版本过高或太低,导致报错,下面这篇文章主要给大家介绍了关于安装多个node版本的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2022-08-08
  • 详解nodejs 开发企业微信第三方应用入门教程

    详解nodejs 开发企业微信第三方应用入门教程

    这篇文章主要介绍了详解nodejs 开发企业微信第三方应用入门教程,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-03-03
  • nodejs版本管理工具nvm的安装与使用小结

    nodejs版本管理工具nvm的安装与使用小结

    在项目开发过程中,使用到vue框架技术,需要安装node下载项目依赖,本文主要介绍了nodejs版本管理工具nvm的安装与使用小结,具有一定的参考价值,感兴趣的可以了解一下
    2024-01-01
  • 基于NodeJS的前后端分离的思考与实践(五)多终端适配

    基于NodeJS的前后端分离的思考与实践(五)多终端适配

    对比基于浏览器的响应式设计方案,因为绝大部分终端探测和渲染逻辑迁移到了服务端,所以在 NodeJS 层进行适配无疑带来了更好的性能和用户体验;另外,相对于一些所谓的「云适配」方案带来的转换质量问题,在基于前后端分离的「定制式」方案中也不会存在。
    2014-09-09
  • 使用node.JS中的url模块解析URL信息

    使用node.JS中的url模块解析URL信息

    本文将详细介绍nodeJS中的URL模块的使用方法,利用URL模块解析出URL相关信息
    2020-02-02
  • 在Node.js中发出HTTP请求的 5 种方法

    在Node.js中发出HTTP请求的 5 种方法

    学习如何在 Node.js 中发出 HTTP 请求可能会让人感到不知所措,因为有数十个可用的库,每个解决方案都声称比上一个更高效,在这篇文章中,我们将探讨在 Node.js 中发出 HTTP 请求的五种最流行的方法,并为每种方法提供说明,需要的朋友可以参考下
    2023-11-11

最新评论