亲宝软件园·资讯

展开

Yapi安装部署教程

hjb2722404 人气:0

Yapi安装部署教程

1.1 环境准备

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镜像来安装。

准备:

在服务器上拉取镜像:

$ 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 访问了。

总结

加载全部内容

相关教程
猜你喜欢
用户评论