docker部署顶尖 API 文档管理工具Yapi

前言介绍

Yapi 由 YMFE 开源,旨在为开发、产品、测试人员提供更优雅的接口管理服务,可以帮助开发者轻松创建、发布、维护 API。

项目地址:https://github.com/YMFE/yapi

一、拉取镜像(镜像地址https://hub.docker.com/r/silsuer/yapi/)

docker pull silsuer/yapi

二、运行镜像生成容器

docker run --name yapi -dit -p 27017:27017 -p 9090:9090 -p 3000:3000 silsuer/yapi bash

三、进入容器

docker attach yapi 或者docker exec -it yapi bash

四、开始部署安装(以下命令需要进入到容器中)

4、1 启动mongodb

service mongodb start

4、2 启动yapi安装程序

yapi server

4、3 根据提示在浏览器中输入ip:9090进行安装,

输入 ip:9090时候出现报错,这是因为容器内部没有git的原因,因此需要安装git

root@21844fbacbcd:/# yapi server
在浏览器打开 http://0.0.0.0:9090 访问。非本地服务器,请将 0.0.0.0 替换成指定的域名或ip 
/bin/sh: 1: xdg-open: not found
当前安装版本: v1.3.9
Error:  连接数据库失败, Authentication failed.
当前安装版本: v1.3.9
连接数据库成功!
开始下载平台文件压缩包...
http://yapi.demo.qunar.com/publicapi/archive/v1.3.9
部署文件完成,正在安装依赖库...
 npm
  ERR! code ENOGIT
 npm
  ERR! No git binary found in $PATH
 npm 
 ERR! 
npm
  ERR! Failed using git.
npm
  ERR! Please check if you have git installed and in your PATH.
npm ERR! A complete log of this run can be found in:
npm ERR!     /root/.npm/_logs/2018-04-11T06_14_07_767Z-debug.log
依赖库安装完成,正在初始化数据库mongodb... 
> yapi@1.3.9 install-server /my-yapi/vendors
>  node server/install.js
Error:  module.js:559
    throw error
Error: Cannot find module 'fs-extra'
    at Function.Module._resolveFilename (module.js:557:15)
    at Function.Module._load (module.js:484:25)
    at Module.require (module.js:606:17)
    at require (internal/module.js:11:18)
    at Object.<anonymous> (/my-yapi/vendors/server/install.js:1:74)
    at Module._compile (module.js:662:30)
    at Object.Module._extensions..js (module.js:673:10)
    at Module.load (module.js:575:32)
    at tryModuleLoad (module.js:515:12)
    at Function.Module._load (module.js:507:3)

这里写图片描述
进入容器

docker exe -it yapi bash

升级apt-get源

apt-get update

安装git

apt-get install git

安装完成之后,浏览器进入ip:9090,参数选择默认,不需要填写管理员帐号密码,直接点击确定就行。
完成安装如下截图:

这里写图片描述

部署日志
当前安装版本: v1.3.9
连接数据库成功!
开始下载平台文件压缩包... http://yapi.demo.qunar.com/publicapi/archive/v1.3.9
部署文件完成,正在安装依赖库...
npm
WARN yapi@1.3.9 license should be a valid SPDX license expression
added 8 packages, removed 6 packages and updated 75 packages in 88.324s
依赖库安装完成,正在初始化数据库mongodb...
> yapi@1.3.9 install-server /my-yapi/vendors > node server/install.js
log: mongodb load success...
初始化管理员账号成功,账号名:"[email protected]",密码:"ymfe.org"
部署成功,请切换到部署目录,输入: "node vendors/server/app.js" 指令启动服务器, 然后在浏览器打开 http://127.0.0.1:3000 访问

4、4 启动yapi

进入到 /my-yapi/ 目录,运行 node vendors/server/app.js 即可启动
执行nohup node /my-yapi/vendors/server/app.js 2>&1 & 在后台运行yapi

4、5 执行ctrl+p+ctrl+q 退出容器,可以使容器在后台运行,不退出。

4、6 项目运行效果

这里写图片描述

猜你喜欢

转载自blog.csdn.net/diyiday/article/details/79896335