Yapi安裝部署詳細(xì)圖文教程
Yapi安裝部署教程
1.1 環(huán)境準(zhǔn)備
nodejs> 7mongodb> 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 安裝
在硬盤上新建一個(gè)用來安裝yapi 的目錄,在目錄下調(diào)出命令終端,執(zhí)行以下命令:
$ yapi server
可視化安裝指引程序會(huì)運(yùn)行在 http://localhost:9090 端口,瀏覽器訪問這個(gè)地址,可以看到安裝界面:

這里部署版本我們選擇 【1.9.2】,這是后面要安裝的釘釘通知插件最新支持到的版本。其它選項(xiàng)保留默認(rèn),直接點(diǎn)擊【開始部署】
1.4 運(yùn)行
等待部署完成,關(guān)閉之前的終端,在yapi安裝目錄下,打開一個(gè)新的終端,執(zhí)行以下命令:
$ node vendors/server/app.js
執(zhí)行后,yapi前端程序會(huì)運(yùn)行在 http://localhost:3000 端口,打開瀏覽器訪問這個(gè)地址,就可以看到安裝好的yapi首頁(yè)了:

當(dāng)然,你可以使用 pm2 來管理這個(gè)服務(wù)。具體參考官方文檔。
1.5 登陸
點(diǎn)擊首頁(yè)的【登陸】按鈕,默認(rèn)管理員賬號(hào)為 【admin@admin.com / ymfe】,可以使用此賬號(hào)登陸,就可以開始使用YAPI了管理你的API了。 如果不是管理員,可以點(diǎn)擊【注冊(cè)】,來注冊(cè)一個(gè)賬號(hào)。
2 容器安裝
使用容器安裝yapi
我們選用mrjin/yapi 這個(gè)docker鏡像來安裝。
準(zhǔn)備:
- linux服務(wù)器
- docker 和 docker-compose
在服務(wù)器上拉取鏡像:
$ docker pull mrjin/yapi:latest
在服務(wù)器上新建一個(gè)目錄,我們此處舉例建立 /home/yapi 目錄:
$ mkdir /home/yapi
在上面新建的目錄下,新建·docker-compose.yml:
# /home/yapi$ touch docker-compose.yml
編輯docker-compose.yml 文件,填充以下內(nèi)容:
// /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 // 修改這里的默認(rèn)管理員賬號(hào)
- 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 // 這里的網(wǎng)絡(luò)名要和下面新建的網(wǎng)絡(luò)名一致
networks:
back-net:
external: true創(chuàng)建docker通信網(wǎng)絡(luò)
$ docker network create back-net
啟動(dòng) docker-compose部署程序
$ docker-compose up -d
啟動(dòng)后,就可以在本地 http://localhost:3000 訪問了。
總結(jié)
到此這篇關(guān)于Yapi安裝部署詳細(xì)圖文教程的文章就介紹到這了,更多相關(guān)Yapi安裝部署教程內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
node.js實(shí)現(xiàn)復(fù)制文本到剪切板的功能
這篇文章主要給大家介紹了node.js實(shí)現(xiàn)復(fù)制文本到剪切板的功能,文中介紹的非常詳細(xì),并給出示例代碼,相信對(duì)大家具有一定的參考借鑒價(jià)值,有需要的朋友們下面來一起看看吧。2017-01-01
詳解Node.js中exports和module.exports的區(qū)別
這篇文章主要介紹了詳解Node.js中exports和module.exports的區(qū)別,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2017-04-04
如何解決安裝websocket還是報(bào)錯(cuò)Cannot find module'ws&apos
這篇文章主要介紹了如何解決安裝websocket還是報(bào)Cannot find module'ws'問題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-02-02
node.js中的模塊化標(biāo)準(zhǔn)CommonJS與自定義模塊
這篇文章介紹了node.js中的模塊化標(biāo)準(zhǔn)CommonJS與自定義模塊,文中通過示例代碼介紹的非常詳細(xì)。對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-06-06
手把手教你實(shí)現(xiàn) Promise的使用方法
這篇文章主要介紹了手把手教你實(shí)現(xiàn) Promise的方法,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-09-09

